aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2020-05-10 15:35:13 -0500
committerEugene Triguba <eugenetriguba@gmail.com>2020-05-10 15:35:13 -0500
commit396cdb8f165cf8b8834595ed93c4265d2e361e6c (patch)
treedf1392d01ccf01e9a8e60a0b58f8548ee0394ee8 /README.md
parentretrieve_all is now get_all and fixed bug with coerceing default return (diff)
downloadconfig-file-396cdb8f165cf8b8834595ed93c4265d2e361e6c.zip
docs: Convert readme to md and remove xml from docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
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
+```