Merge pull request #28 from jrobichaud/patch-1

Fix typos in readme

Author: TimurKady

README.md

@@ -3,14 +3,14 @@
 
 [![Tests](https://github.com/TimurKady/django-fast-treenode/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/TimurKady/django-fast-treenode/actions/workflows/test.yaml)
 [![Docs](https://readthedocs.org/projects/django-fast-treenode/badge/?version=latest)](https://django-fast-treenode.readthedocs.io/)
-[![PyPI](https://img.shields.io/pypi/v/django-fast-treenode.svg)](https://pypi.org/project/django-fast-Treenode/)
+[![PyPI](https://img.shields.io/pypi/v/django-fast-treenode.svg)](https://pypi.org/project/django-fast-treenode/)
 [![Published on Django Packages](https://img.shields.io/badge/Published%20on-Django%20Packages-0c3c26)](https://djangopackages.org/packages/p/django-fast-treenode/)
 [![Sponsor](https://img.shields.io/github/sponsors/TimurKady)](https://github.com/sponsors/TimurKady)
 
 ## About The Treenode Framework
 ### Overview
 
-**Treenode Framework** is an advanced tree management system for Django applications.It is designed to handle large-scale, deeply nested, and highly dynamic tree structures while maintaining excellent performance, data integrity, and ease of use.
+**Treenode Framework** is an advanced tree management system for Django applications. It is designed to handle large-scale, deeply nested, and highly dynamic tree structures while maintaining excellent performance, data integrity, and ease of use.
 
 Unlike traditional solutions, **Treenode Framework** is built for serious real-world applications where trees may consist of:
 
@@ -23,7 +23,7 @@ Its core philosophy: **maximum scalability, minimum complexity**.
 
 ### Key Features
 #### Common operations
-The `django-fast-Treenode` package supports all the basic operations needed to work with tree structures:
+The `django-fast-treenode` package supports all the basic operations needed to work with tree structures:
 
 - Extracting **ancestors** (queryset, list, pks, count);
 - Extracting **children** (queryset, list, pks, count);
@@ -39,7 +39,7 @@ The `django-fast-Treenode` package supports all the basic operations needed to w
 - Finding the **lowest common ancestor** of two nodes;
 - Finding the **shortest path** between two nodes.
 
-Due to its high performance and ability to support deep nesting and large tree sizes, the `django-fast-treeode` package can be used for any tasks that involve the use of tree-like data, with virtually no restrictions.
+Due to its high performance and ability to support deep nesting and large tree sizes, the `django-fast-treenode` package can be used for any tasks that involve the use of tree-like data, with virtually no restrictions.
 
 ### Where Massive Trees Really Matter?
 
@@ -55,9 +55,9 @@ Typical applications include:
 In all these domains, scalable and fast tree management is not a luxury — it's a necessity.
 
 ### Why Treenode Framework?
-At the moment, django-fast-treeenode is, if not the best, then one of the best packages for working with tree data under Djangjo.
+At the moment, `django-fast-treenode` is, if not the best, then one of the best packages for working with tree data under Django.
 
-- **High performance**: [tests show](docs/about.md#benchmark-tests) that on trees of 5k-10k nodes with a nesting depth of 500-600 levels, **Treenode Framework** (`django-fast-Treenode`) shows **performance 4-7 times better** than the main popular packages.
+- **High performance**: [tests show](docs/about.md#benchmark-tests) that on trees of 5k-10k nodes with a nesting depth of 500-600 levels, **Treenode Framework** (`django-fast-treenode`) shows **performance 4-7 times better** than the main popular packages.
 - **Flexible API**: today contains the widest set of methods for working with a tree in comparison with other packages.
 - **Convenient administration**: the admin panel interface was developed taking into account the experience of using other packages. It provides convenience and intuitiveness with ease of programming.
 - **Scalability**: **Treenode Framework** suitable for solving simple problems such as menus, directories, parsing arithmetic expressions, as well as complex problems such as program optimization, image layout, multi-step decision making problems, or machine learning..
@@ -71,7 +71,7 @@ To get started quickly, you need to follow these steps:
 
 - Simply install the package via `pip`:
   ```sh
-  pip install django-fast-Treenode
+  pip install django-fast-treenode
   ```
 - Once installed, add `'treenode'` to your `INSTALLED_APPS` in **settings.py**:
   ```python {title="settings.py"}
@@ -84,7 +84,7 @@ To get started quickly, you need to follow these steps:
 
 - Open **models.py** and create your own tree class:
   ```
-  from Treenode.models import TreenodeModel
+  from treenode.models import TreenodeModel
 
   class MyTree(TreenodeModel):
     name = models.CharField(max_length=255)
@@ -94,7 +94,7 @@ To get started quickly, you need to follow these steps:
 - Open **admin.py** and create a model for the admin panel
   ```
   from django.contrib import admin
-  from Treenode.admin import TreenodeModelAdmin
+  from treenode.admin import TreenodeModelAdmin
   from .models import MyTree
 
   @admin.register(MyTree)
@@ -116,25 +116,26 @@ To get started quickly, you need to follow these steps:
 Everything is ready, enjoy 🎉!
 
 ## Documentation
-Full documentation is available at **[ReadTheDocs](https://django-fast-Treenode.readthedocs.io/)**.
+Full documentation is available at **[ReadTheDocs](https://django-fast-treenode.readthedocs.io/)**.
 
 Quick access links:
-* [Installation, configuration and fine tuning](https://django-fast-Treenode.readthedocs.io/installation/)
-* [Model Inheritance and Extensions](https://django-fast-Treenode.readthedocs.io/models/)
-* [Working with Admin Classes](https://django-fast-Treenode.readthedocs.io/admin/)
-* [API Reference](https://django-fast-Treenode.readthedocs.io/api/)
-* [Import & Export](https://django-fast-Treenode.readthedocs.io/import_export/)
-* [Caching and working with cache](https://django-fast-Treenode.readthedocs.io/cache/)
-* [Migration and upgrade guide](https://django-fast-Treenode.readthedocs.io/migration/)
+* [Installation, configuration and fine tuning](https://django-fast-treenode.readthedocs.io/installation/)
+* [Model Inheritance and Extensions](https://django-fast-treenode.readthedocs.io/models/)
+* [Working with Admin Classes](https://django-fast-treenode.readthedocs.io/admin/)
+* [API Reference](https://django-fast-treenode.readthedocs.io/api/)
+* [Import & Export](https://django-fast-treenode.readthedocs.io/import_export/)
+* [Caching and working with cache](https://django-fast-treenode.readthedocs.io/cache/)
+* [Migration and upgrade guide](https://django-fast-treenode.readthedocs.io/migration/)
 
 Your wishes, objections, comments are welcome.
 
 ## License
-Released under [MIT License](https://github.com/TimurKady/django-fast-Treenode/blob/main/LICENSE).
+Released under [MIT License](https://github.com/TimurKady/django-fast-treenode/blob/main/LICENSE).
 
 ## Credits
 Thanks to everyone who contributed to the development and testing of this package, as well as the Django community for their inspiration and support. 
 
 Special thanks to [Fabio Caccamo](https://github.com/fabiocaccamo) for the idea behind creating a fast Django application for handling hierarchies.
 
 Also special thanks to everyone who supports the project with their [sponsorship donations](https://github.com/sponsors/TimurKady).
+