summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..44d074b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# hatch-django-collectstatic
+
+Collect a django project's static files into its binary distribution
+archive.
+
+Example usage:
+
+```
+[build-system]
+requires = ["hatchling >= 1.26", "hatch-django-collectstatic"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel.hooks.django-collectstatic]
+settings = "ppr.project.settings"
+
+[tool.hatch.build.targets.wheel.shared-data]
+"static" = "share/static"
+```