Updated README.md with features, bumped to v0.1.1

README.md

@@ -1,12 +1,21 @@
 # paya - Simple tool that converts YAML configuration files to Python objects
 
 ![PyPI - Downloads](https://img.shields.io/pypi/dd/pyya)
+[![ClickPy Dashboard](https://img.shields.io/badge/clickpy-dashboard-orange)](https://clickpy.clickhouse.com/dashboard/pyya)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyya)
 [![PyPI - Link](https://img.shields.io/badge/pypi-link-blue)](https://pypi.org/project/pyya/)
 ![PyPI - Version](https://img.shields.io/pypi/v/pyya)
 ![PyPI - Wheel](https://img.shields.io/pypi/wheel/pyya)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
+## Features
+
+- Very `lightweight` and `simple` API (currently it contains only one function)
+- `Easy` to use
+- Based on popular and well-tested libraries (like `camel-converter` and `munch`)
+- Automatically `merge` default and production configuration files
+- Convert keys in configuration files to `snake_case`
+
 
 ## Installation
 
@@ -53,19 +62,20 @@ print(json.dumps(config.database))
 
 ```
 
-As you can see, pyya automatically merges default config file with production config file.
+As you can see, `pyya` automatically merges default config file with production config file.
 
 Under the hood `pyya` uses [munch](https://pypi.org/project/munch/) library to create attribute-stylish dictionaries.
 
-`paya` automatically adds underscore prefix to Python keywords and can be configured to convert `camelCase` or `PascalCase` keys to snake_case. 
+`paya` automatically adds underscore prefix to Python keywords and can be configured to convert `camelCase` or `PascalCase` keys to `snake_case`. 
 
-If `raise_error_non_identifiers` is True, `pyya` will raise error if section name is not valid Python identifier.
+If `raise_error_non_identifiers=True`, `pyya` will raise error if section name is not valid Python identifier.
 
 ## Contributing
 
 Are you a developer?
 
-- Fork the repository
+- Fork the repository `https://github.com/shadowy-pycoder/pyya/fork`
+- Clone the repository: `git clone https://github.com/<your-username>/pyya.git && cd pyya`
 - Create your feature branch: `git switch -c my-new-feature`
 - Commit your changes: `git commit -am 'Add some feature'`
 - Push to the branch: `git push origin my-new-feature`

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyya"
-version = "0.1.0"
+version = "0.1.1"
 authors = [
   { name="shadowy-pycoder", email="[email protected]" },
 ]

pyya.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyya
-Version: 0.1.0
+Version: 0.1.1
 Summary: Convert YAML configuration files to Python objects
 Author-email: shadowy-pycoder <[email protected]>
 Project-URL: Homepage, https://github.com/shadowy-pycoder/pyya
@@ -26,8 +26,22 @@ Requires-Dist: types-pyyaml>=6.0.12.20240917
 
 # paya - Simple tool that converts YAML configuration files to Python objects
 
+![PyPI - Downloads](https://img.shields.io/pypi/dd/pyya)
+[![ClickPy Dashboard](https://img.shields.io/badge/clickpy-dashboard-orange)](https://clickpy.clickhouse.com/dashboard/pyya)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyya)
+[![PyPI - Link](https://img.shields.io/badge/pypi-link-blue)](https://pypi.org/project/pyya/)
+![PyPI - Version](https://img.shields.io/pypi/v/pyya)
+![PyPI - Wheel](https://img.shields.io/pypi/wheel/pyya)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
+## Features
+
+- Very `lightweight` and `simple` API (currently it contains only one function)
+- `Easy` to use
+- Based on popular and well-tested libraries (like `camel-converter` and `munch`)
+- Automatically `merge` default and production configuration files
+- Convert keys in configuration files to `snake_case`
+
 
 ## Installation
 
@@ -74,19 +88,20 @@ print(json.dumps(config.database))
 
 ```
 
-As you can see, pyya automatically merges default config file with production config file.
+As you can see, `pyya` automatically merges default config file with production config file.
 
 Under the hood `pyya` uses [munch](https://pypi.org/project/munch/) library to create attribute-stylish dictionaries.
 
-`paya` automatically adds underscore prefix to Python keywords and can be configured to convert `camelCase` or `PascalCase` keys to snake_case. 
+`paya` automatically adds underscore prefix to Python keywords and can be configured to convert `camelCase` or `PascalCase` keys to `snake_case`. 
 
-If `raise_error_non_identifiers` is True, `pyya` will raise error if section name is not valid Python identifier.
+If `raise_error_non_identifiers=True`, `pyya` will raise error if section name is not valid Python identifier.
 
 ## Contributing
 
 Are you a developer?
 
-- Fork the repository
+- Fork the repository `https://github.com/shadowy-pycoder/pyya/fork`
+- Clone the repository: `git clone https://github.com/<your-username>/pyya.git && cd pyya`
 - Create your feature branch: `git switch -c my-new-feature`
 - Commit your changes: `git commit -am 'Add some feature'`
 - Push to the branch: `git push origin my-new-feature`