Merge pull request #15 from talgat-abdraimov/chore/improvements

added readme

Author: talgat-abdraimov

README.md

@@ -0,0 +1,39 @@
+# python project template :information_desk_person:
+
+This is a highly opinionated template for Python projects.
+
+---
+
+## Usage
+
+1. On GitHub.com, navigate to the main page of the [repository](https://github.com/talgat-abdraimov/python-project-template).
+
+2. Above the file list, click **Use this template**.
+
+3. Select **Create a new repository**.
+
+4. Type a name for your repository, and an optional description.
+
+5. Click **Create repository from template**.
+
+6. Wait about 20 seconds then refresh this page. [GitHub Actions](https://docs.github.com/en/actions) will automatically update the README.md
+
+> **Note:** More details can be found [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template#creating-a-repository-from-a-template)
+
+## Tools
+
+### pre-commit
+
+Before you can run hooks, you must have the pre-commit package manager installed.
+
+[see more](https://pre-commit.com/)
+
+### ruff
+
+Ruff aims to be significantly faster than alternative tools while integrating more functionality behind a single, common interface.
+
+[see more](https://docs.astral.sh/ruff/)
+
+### pytest
+
+The pytest framework makes it easy to write small, readable tests, and can scale to support complex functional testing for applications and libraries. [see more](https://docs.pytest.org/en/7.4.x/)