diff --git a/README.md b/README.md index bb271f8..d09b209 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,34 @@ # dxh_py -A python CLI to generate pypi packages. +A Python CLI tool to generate PyPI packages effortlessly. ## Installation +To install `dxh_py`, use pip: + ```sh pip install dxh-py ``` ## Usage +To generate a PyPI package from a GitHub repository, run: + ```sh dxh_py https://github.com/devxhub/django-boilerplate ``` + +## Features + +- Simple and intuitive CLI +- Automates the creation of PyPI packages from GitHub repositories +- Supports both source distributions and wheel builds + +## Contributing + +Contributions are welcome! Please open an issue or submit a pull request on GitHub. + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. +```