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 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md (limited to 'README.md') 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 +``` -- cgit v1.2.3