From 4369cdd44fefe539e45b2e07ae35f72c04f4ff29 Mon Sep 17 00:00:00 2001 From: S4NKALP Date: Wed, 29 Oct 2025 13:56:24 +0545 Subject: [PATCH] docs: update README with PyPI package name and installation instructions --- README.md | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 4f829c0..b046db1 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,15 @@ # djinit -

- Django - Python - License -

+
+ +> PyPI did not allow the original name, so the package is released as **djinitx** + +PyPI +Django +Python +License + +
A fast, interactive CLI to bootstrap a modern, production‑ready Django project in minutes — featuring split settings, DRF and JWT integration, OpenAPI docs, CORS, static file handling via WhiteNoise, Postgres‑friendly configuration, CI/CD templates, deployment helpers, and battle‑tested defaults that deliver a polished developer experience out of the box. @@ -19,24 +24,24 @@ A fast, interactive CLI to bootstrap a modern, production‑ready Django project --- -## Demo - -![djinit demo](docs/demo.gif) - -Tip: If the GIF doesn't load, open `docs/demo.gif` or view it on the repository page. - ## Installation Using pipx (recommended): ```bash -pipx install git+https://github.com/S4NKALP/djinit +pipx install djinitx ``` -Using pip (user space): +Using pip: ```bash -pip install --user git+https://github.com/S4NKALP/djinit +pip install djinitx +``` + +Using uv: + +```bash +uv tool install djinitx ``` From source: