From 74e1fd49d367219e7c2ea8aab6de5eb85b4a0966 Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Sat, 16 Aug 2025 12:28:38 -0400 Subject: Update readme --- README.md | 58 ++++++++++++++++++---------------------------------------- 1 file changed, 18 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 45c366e..26ffa13 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,21 @@ -

- Config File -

- -

- - Simple manipulation of ini, json, yaml, or toml files - -

- -

- Python Version - Version - Build Status -

- -

- The Config File project is designed to allow you to easily manipulate your - configuration files with the same simple API whether they are in INI, JSON, - YAML, or TOML. -

- -## Quick start +# Config File + +> Simple manipulation of ini, json, yaml, or toml 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/) +[![Build Status](https://builds.sr.ht/~eugenetriguba/config-file.svg)](https://builds.sr.ht/~eugenetriguba/config-file?) + +## About Config File + +The Config File project is designed to allow you to easily manipulate your +configuration files with the same simple API whether they are in INI, JSON, +YAML, or TOML. + +Visit [config-file.readthedocs.io](https://config-file.readthedocs.io/) for +further documentation. + +## Installation Config File is available to download through PyPI. @@ -44,11 +30,3 @@ If you want to manipulate YAML and TOML, you'll want to download the extras as w ```bash $ pip install config-file[yaml, toml] ``` - -For detailed documentation, visit -[config-file.readthedocs.io](https://config-file.readthedocs.io/) - -## License - -The [MIT](https://github.com/eugenetriguba/config-file/blob/main/LICENSE) License. - -- cgit v1.2.3