Merge pull request #5 from CrispenGari/docs

Docs

Author: CrispenGari

Changelog.md

@@ -1,52 +1,49 @@
-### dataloom Changelog
+===============================================================================================================================================
+**`1.0.2`**
+===============================================================================================================================================
 
-Change logs for the `dataloom` Version `1.0.2` (`2021-02-12`)
+We have release the new `dataloom` Version `1.0.2` (`2024-02-12`)
 
-### New Features
-
-- **Docstring**: Now the functions and classes have a beautiful docstring that helps ypu with some examples and references in the editor.
-- **SQL Loggers**: The SQL Loggers can now log `timestamps` not the log index especially for the `console` logger.
-
-### Enhancements
-
-- None
-
-### Bug Fixes
-
-- **log_index**: There was a bug with `log_index` that was breaking the entire sofware that has been fixed.
-
-### Performance Improvements
+### Changes
 
-- None
+We have updated the documentation so that it can look more colorful.
 
-### Security Updates
+===============================================================================================================================================
+**`1.0.1`**
+===============================================================================================================================================
 
-- None
+Change logs for the `dataloom` Version `1.0.1` (`2024-02-12`)
 
-### Deprecations
-
-- None
-
-### API Changes
-
-- None
-
-### Compatibility Changes
-
-- None
+### New Features
 
-### Documentation Updates
+- **Docstring**: Now the functions and classes have a beautiful docstring that helps ypu with some examples and references in the editor.
+- **SQL Loggers**: The SQL Loggers can now log `timestamps` not the log index especially for the `console` logger.
 
-- None
+===============================================================================================================================================
+**`1.0.0`**
+===============================================================================================================================================
 
-### Internal Changes
+### Release Notes - `dataloom`
 
-- None
+We are pleased to release `dataloom` ORM for python version `3.12` and above. The dataloom version `1.0.0 ` released on (`2024-02-11`) is bug-free and ready to be used with the following features.
 
-### Known Issues
+##### Features
 
-- None
+- Initial release of `dataloom`.
+- Lightweight and versatile Object-Relational Mapping (ORM) functionality.
+- Support for `PostgreSQL`, `MySQL`, and `SQLite3` databases.
+- Simplified database interactions for developers.
 
-### Miscellaneous
+### What you can do
 
-- None
+- Create records
+- Delete records
+- Update records
+- Read records
+- Inspect Models
+- SQL logging
+- Association Mapping
+- Order Records
+- Filter Records
+- Select field in records
+- etc.

README.md

@@ -6,6 +6,15 @@
 <img src="https://github.com/CrispenGari/dataloom/blob/main/dataloom.png?raw=true" alt="dataloom" width="200">
 </p>
 
+---
+
+<p align="center">
+  <a href="https://pypi.python.org/pypi/dataloom"><img src="https://badge.fury.io/py/dataloom.svg"></a>
+  <a href="https://github.com/crispengari/dataloom/actions/workflows/ci.yml"><img src="https://github.com/crispengari/dataloom/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green"></a>
+  <a href="https://pypi.python.org/pypi/dataloom"><img src="https://img.shields.io/pypi/pyversions/dataloom.svg"></a>
+</p>
+
 #### Why choose `dataloom`?
 
 1. **Ease of Use**: `dataloom` offers a user-friendly interface, making it straightforward to work with.

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "dataloom"
-version = "1.0.1"
+version = "1.0.2"
 authors = [
     {name = "Crispen Gari", email = "crispengari@gmail.com"},
 ]