New README.md

[bleudev]

closes #49

Summary by Sourcery

Update the README.md to enhance its content and structure, including a project logo, feature highlights, installation instructions, contribution guidelines, and support information.

Documentation:

• Revamp the README.md to include a project logo, badges for PyPI version, Python version, documentation, Pylint, and Black.
• Add sections detailing key features of the ufpy package, including UDict, GitHub repository downloads, and type aliases.
• Provide installation instructions for the latest, specific, and development versions of ufpy using pip.
• Include a contributing guide with links to the GitHub repository and website repository for documentation contributions.
• Add a support section with information on how to open discussions and provide feedback on GitHub.

[sourcery-ai[bot]]

Reviewer's Guide by Sourcery

This pull request significantly updates the README.md file for the ufpy project. The changes include adding a project logo, badges, and comprehensive sections on key features, installation instructions, contribution guidelines, and support information. The new README provides a more professional and informative introduction to the project, enhancing its visibility and usability for potential users and contributors.

File-Level Changes

Change	Details	Files
Add project logo and badges	Include SVG logo with light and dark mode support Add badges for PyPI version, Python version, documentation, Pylint, and Black	README.md
Expand project description and key features	Provide a brief description of ufpy (Useful Python) List key features including UDict, GitHub repository downloading, and type aliases Add links to more detailed documentation for each feature	README.md
Add installation instructions	Include commands for installing the latest version Provide instructions for installing a specific version Add command for installing the development version from GitHub	README.md
Include contribution guidelines	Provide information on how to contribute to the main project Add instructions for contributing to the documentation website	README.md
Add support section	Provide guidance on opening discussions for questions or problems Encourage users to share suggestions and ideas through GitHub discussions	README.md

---

Tips

- Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.

[bleudev]

@sourcery-ai review

[bleudev]

@sourcery-ai review

[bleudev]

@sourcery-ai review

[bleudev]

Ready for merge!