docs: changelogs updated

CHANGELOG.md

@@ -22,6 +22,7 @@ All notable changes to this project will be documented in this file.
 - Fixing authors.md
 - Fixing authors.md
 - Fixed other doc files
+- Syntax fixed. chore: added comments in serialise method of the MantarayFork class
 
 ### 🧪 Testing
 
@@ -41,6 +42,7 @@ All notable changes to this project will be documented in this file.
 
 - Updated changelog
 - Updated changelog
+- Updated core version manager to regex_commit from hatch-vcs
 
 ### Del
 

LICENSE

@@ -1,6 +1,4 @@
-
-
-BSD License
+BSD 3-Clause License
 
 Copyright (c) 2024, Saikat Karmakar
 All rights reserved.
@@ -29,4 +27,3 @@ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 OF THE POSSIBILITY OF SUCH DAMAGE.
-

README.md

@@ -4,18 +4,38 @@
     <em>Mantaray data structure in Python</em>
 </p>
 
-[![build](https://github.com/aviksaikat/mantaray-py/workflows/Build/badge.svg)](https://github.com/aviksaikat/mantaray-py/actions)
-[![codecov](https://codecov.io/gh/aviksaikat/mantaray-py/branch/master/graph/badge.svg)](https://codecov.io/gh/aviksaikat/mantaray-py)
-[![PyPI version](https://badge.fury.io/py/mantaray-py.svg)](https://badge.fury.io/py/mantaray-py)
+<div align="center">
+
+| Feature       | Value                     |
+| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Technology    | [![Python](https://img.shields.io/badge/Python-3776AB.svg?style=flat&logo=Python&logoColor=white)](https://www.python.org/) [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) [![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-2088FF.svg?style=flat&logo=GitHub-Actions&logoColor=white)](https://github.com/features/actions) [![Pytest](https://img.shields.io/badge/Pytest-0A9EDC.svg?style=flat&logo=Pytest&logoColor=white)](https://github.com/Ankvik-Tech-Labs/mantaray-py/actions/workflows/tests.yml/badge.svg)                           |
+| Type Checking | [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| CI/CD         | [![Release](https://github.com/Ankvik-Tech-Labs/mantaray-py/actions/workflows/release.yml/badge.svg)](https://github.com/Ankvik-Tech-Labs/mantaray-py/actions/workflows/build.yml) [![Tests](https://github.com/Ankvik-Tech-Labs/mantaray-py/actions/workflows/tests.yml/badge.svg)](https://github.com/Ankvik-Tech-Labs/mantaray-py/actions/workflows/tests.yml) [![Labeler](https://github.com/Ankvik-Tech-Labs/mantaray-py/actions/workflows/labeler.yml/badge.svg)](https://github.com/Ankvik-Tech-Labs/mantaray-py/actions/workflows/labeler.yml) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![codecov](https://codecov.io/gh/Ankvik-Tech-Labs/mantaray-py/graph/badge.svg?token=ISTIW37DO6)](https://codecov.io/gh/Ankvik-Tech-Labs/mantaray-py)                                                                                                                                                                                                           |
+| Docs          | [![Docs](https://github.com/Ankvik-Tech-Labs/mantaray-py/actions/workflows/documentation.yml/badge.svg)](https://github.com/Ankvik-Tech-Labs/mantaray-py/actions/workflows/build.yml)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+| Package       | [![PyPI - Version](https://img.shields.io/pypi/v/mantaray-py.svg)](https://pypi.org/project/mantaray-py/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mantaray-py)](https://pypi.org/project/mantaray-py/) [![PyPI - License](https://img.shields.io/pypi/l/mantaray-py)](https://pypi.org/project/mantaray-py/)                                                                                                                                                                                                                                                                                                                                                                                                        |
+| Meta          | [![GitHub license](https://img.shields.io/github/license/Ankvik-Tech-Labs/mantaray-py?style=flat&color=1573D5)](https://github.com/Ankvik-Tech-Labs/mantaray-py/blob/main/LICENSE) [![GitHub last commit](https://img.shields.io/github/last-commit/Ankvik-Tech-Labs/mantaray-py?style=flat&color=1573D5)](https://github.com/Ankvik-Tech-Labs/mantaray-py/commits/main) [![GitHub commit activity](https://img.shields.io/github/commit-activity/m/Ankvik-Tech-Labs/mantaray-py?style=flat&color=1573D5)](https://github.com/Ankvik-Tech-Labs/mantaray-py/graphs/commit-activity) [![GitHub top language](https://img.shields.io/github/languages/top/Ankvik-Tech-Labs/mantaray-py?style=flat&color=1573D5)](https://github.com/Ankvik-Tech-Labs/mantaray-py) |
+
+</div>
+
+# Installation
+
+- Install using `pip`
+```py
+pip install mantaray-py
+```
 
 ---
 
-**Documentation**: <a href="https://aviksaikat.github.io/mantaray-py/" target="_blank">https://aviksaikat.github.io/mantaray-py/</a>
+**Documentation**: <a href="https://Ankvik-Tech-Labs.github.io/mantaray-py/" target="_blank">https://Ankvik-Tech-Labs.github.io/mantaray-py/</a>
 
-**Source Code**: <a href="https://github.com/aviksaikat/mantaray-py" target="_blank">https://github.com/aviksaikat/mantaray-py</a>
+**Source Code**: <a href="https://github.com/Ankvik-Tech-Labs/mantaray-py" target="_blank">https://github.com/Ankvik-Tech-Labs/mantaray-py</a>
 
 ---
 
+<details close>
+<summary>Development</summary>
+<br>
+
 ## Development
 
 ### Setup environment
@@ -27,15 +47,15 @@ We use [Hatch](https://hatch.pypa.io/latest/install/) to manage the development
 You can run all the tests with:
 
 ```bash
-hatch run test
+hatch run test:test
 ```
 
 ### Format the code
 
 Execute the following command to apply linting and check typing:
 
 ```bash
-hatch run lint
+hatch run lint:lint-check
 ```
 
 ### Publish a new version
@@ -63,11 +83,13 @@ When you push the tag on GitHub, the workflow will automatically publish it on P
 You can serve the Mkdocs documentation with:
 
 ```bash
-hatch run docs-serve
+hatch run docs:docs-serve
 ```
 
 It'll automatically watch for changes in your code.
 
+</details>
+
 ## License
 
-This project is licensed under the terms of the BSD license.
+This project is licensed under the terms of the [BSD 3-Clause License](./LICENSE) license.