diff options
| author | Eugene Triguba <hello@eugenetriguba.com> | 2025-08-16 12:28:38 -0400 |
|---|---|---|
| committer | Eugene Triguba <hello@eugenetriguba.com> | 2025-08-16 12:28:38 -0400 |
| commit | 74e1fd49d367219e7c2ea8aab6de5eb85b4a0966 (patch) | |
| tree | 93af5c090ae68fc988c4d2f36cbe682fc114b559 | |
| parent | Move usage to mkdocs (diff) | |
| download | config-file-74e1fd49d367219e7c2ea8aab6de5eb85b4a0966.zip | |
Update readme
| -rw-r--r-- | README.md | 58 |
1 files changed, 18 insertions, 40 deletions
@@ -1,35 +1,21 @@ -<p align="center"> - Config File -</p> - -<p align="center"> - <strong> - Simple manipulation of ini, json, yaml, or toml files - </strong> -</p> - -<p align="center"> - <a href="https://pypi.org/config-file"><img - src="https://img.shields.io/pypi/pyversions/config-file.svg" - alt="Python Version" - /></a> - <a href="https://pypi.org/config-file"><img - src="https://img.shields.io/pypi/v/config-file" - alt="Version" - /></a> - <a href="https://builds.sr.ht/~eugenetriguba/config-file?"><img - src="https://builds.sr.ht/~eugenetriguba/config-file.svg" - alt="Build Status" - /></a> -</p> - -<p align="center"> - 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. -</p> - -## Quick start +# Config File + +> Simple manipulation of ini, json, yaml, or toml files + + +[](https://pypi.org/project/config-file/) +[](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. - |