diff options
| author | Eugene Triguba <eugenetriguba@gmail.com> | 2020-02-02 16:39:48 -0600 |
|---|---|---|
| committer | Eugene Triguba <eugenetriguba@gmail.com> | 2020-02-02 16:39:48 -0600 |
| commit | effe00be8f1413ed57e3dac2ff73e012696831a7 (patch) | |
| tree | 488849998fd0e6bd6abc1251d02891bd039cd448 /README.rst | |
| parent | Add sphinx-quickstart (diff) | |
| download | config-file-effe00be8f1413ed57e3dac2ff73e012696831a7.zip | |
Move some of the docs over to sphinx on a RTD theme
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..525e95e --- /dev/null +++ b/README.rst @@ -0,0 +1,34 @@ +Config File +=========== + + Manage and manipulate your configuration files + +|Python Verison| |Version| |Style| |Documentation Status| |Build Status| |Codecov| + + This python package is currently in rapid development and is in a + pre-alpha phase. The API is liable to break until v1 so if you're + going to use it, pinning the version is recommended. All notable + changes are kept track of in the changelog. + +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. + +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
\ No newline at end of file |