From 396cdb8f165cf8b8834595ed93c4265d2e361e6c Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Sun, 10 May 2020 15:35:13 -0500 Subject: docs: Convert readme to md and remove xml from docs --- README.md | 24 ++++++++++++++++++++++++ README.rst | 31 ------------------------------- docs/source/index.rst | 2 +- 3 files changed, 25 insertions(+), 32 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 0000000..8284fa4 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Config File + +> Manage and manipulate your configuration files + +![Python Version](https://img.shields.io/pypi/pyversions/config-file.svg) +[![Version](https://img.shields.io/pypi/v/config-file)](https://pypi.org/project/config-file/) +[![Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://pypi.org/project/black/) +[![Documentation Status](https://readthedocs.org/projects/config-file/badge/?version=latest)](https://config-file.readthedocs.io/en/latest/?badge=latest) +[![Build Status](https://travis-ci.com/eugenetriguba/config-file.svg?branch=master)](https://travis-ci.com/eugenetriguba/config-file) +[![Codecov](https://codecov.io/gh/eugenetriguba/config-file/graph/badge.svg)](https://codecov.io/gh/eugenetriguba/config-file) + +Config File allows you to use the same simple API for manipulating INI, +JSON, YAML, and TOML configuration files. For the time being, it only +supports INI and JSON. + +## Documentation + +Full documentation is available at https://config-file.readthedocs.io + +## Installation + +```bash +$ pip install config-file +``` diff --git a/README.rst b/README.rst deleted file mode 100644 index 1cc8592..0000000 --- a/README.rst +++ /dev/null @@ -1,31 +0,0 @@ -Config File -=========== - - Manage and manipulate your configuration files - -|Python Verison| |Version| |Style| |Documentation Status| |Build Status| |Codecov| - -Config File allows you to use the same simple API for manipulating INI, -JSON, YAML, and TOML configuration files. For the time being, it only -supports INI and JSON. - -Full documentation is available at https://config-file.readthedocs.io - -Installation ------------- - -.. code:: bash - - $ pip install config-file - -.. |Python Verison| image:: https://img.shields.io/pypi/pyversions/config-file.svg -.. |Version| image:: https://img.shields.io/pypi/v/config-file - :target: https://pypi.org/project/config-file/ -.. |Style| image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://pypi.org/project/black/ -.. |Documentation Status| image:: https://readthedocs.org/projects/config-file/badge/?version=latest - :target: https://config-file.readthedocs.io/en/latest/?badge=latest -.. |Build Status| image:: https://travis-ci.com/eugenetriguba/config-file.svg?branch=master - :target: https://travis-ci.com/eugenetriguba/config-file -.. |Codecov| image:: https://codecov.io/gh/eugenetriguba/config-file/graph/badge.svg - :target: https://codecov.io/gh/eugenetriguba/config-file diff --git a/docs/source/index.rst b/docs/source/index.rst index f4baa8d..6b59715 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -2,7 +2,7 @@ Config File Documentation ========================= Config File is a package that allows you to easily manipulate your configuration -files whether they are in INI, JSON, YAML, TOML, or even XML. +files whether they are in INI, JSON, YAML, or TOML. **Table of Contents:** -- cgit v1.2.3