diff --git a/README.md b/README.md index 0bed35b..5c7f466 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,83 @@ -# ufpy -Ufpy (Useful Python) - package for Python with some useful features +

+ + + + Logo + +

+ +

+ + Pypi + + + Python version + + + Docs + + + Pylint + + + Black + +

+ +Ufpy (Useful Python) - package for Python with some useful features which can help you! + +# Key features + +- Useful dict (UDict) for simplification working with dictionaries. [See more...](examples/udict.md) +- Download GitHub's public repositories, its folders and files. [See more...](examples/github/download.md) +- Some type alias and protocols +- And more! + +# Installation + +## Install latest version + +To install `ufpy` with `pip` use this command in your shell +```sh +pip install ufpy +``` + +## Install specific version + +To install specific version of `ufpy` with `pip` use this command in your shell +```sh +# Example: install ufpy 0.2 +pip install ufpy==0.2 +``` + +## Install dev version + +To install dev version with `pip` use this command in your shell +```sh +pip install git+https://github.com/honey-team/ufpy.git +``` + +# Contributing + +You can contribute to this project via [GitHub](https://github.com/honey-team/ufpy). Here's how: +1. Fork the repository +2. Create a new branch for your feature or bug fix +3. Make your changes, following our [coding standards](/CONTRIBUTING.md/) +4. Write tests for your changes +5. Ensure all tests pass +6. Submit a pull request with a clear description of your changes +For more detailed guidelines, please see our [Contributing Guide](/CONTRIBUTING.md). + +If you want to contribute to docs website, fork [website repository](https://github.com/honey-team/ufpy-website) and open pull request! + +# Support + +If you have a problem or just have a question, open [discussion in GitHub](https://github.com/honey-team/ufpy/discussions). Also you can tell me your suggestions and ideas in this [discussions](https://github.com/honey-team/ufpy/discussions). + +Enjoy `ufpy`! I'd like to see that my project will be using in your projects. Bye! :) diff --git a/readme_assets/logo.svg b/readme_assets/logo.svg new file mode 100644 index 0000000..31c344c --- /dev/null +++ b/readme_assets/logo.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/readme_assets/logo_d.svg b/readme_assets/logo_d.svg new file mode 100644 index 0000000..315b2b6 --- /dev/null +++ b/readme_assets/logo_d.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/readme_assets/logo_l.svg b/readme_assets/logo_l.svg new file mode 100644 index 0000000..c21e3c1 --- /dev/null +++ b/readme_assets/logo_l.svg @@ -0,0 +1,5 @@ + + + + +