summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorfrappe <frappe@c5102bb99250>2026-03-17 17:56:48 +0000
committerfrappe <frappe@c5102bb99250>2026-03-17 17:56:48 +0000
commit2a9e19e287e77dd00e38f148b5da5c1acb3c754d (patch)
tree60658dd9b30171d685755a201ad059ee92c68699 /README.md
downloadsupportive_help-2a9e19e287e77dd00e38f148b5da5c1acb3c754d.tar.xz
supportive_help-2a9e19e287e77dd00e38f148b5da5c1acb3c754d.zip
feat: Initialize App
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a1177b6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+### Supportive Help
+
+The \"Supportive Assistance\" module provides administrative support for activities covered by the German Social Code.
+
+### Installation
+
+You can install this app using the [bench](https://github.com/frappe/bench) CLI:
+
+```bash
+cd $PATH_TO_YOUR_BENCH
+bench get-app $URL_OF_THIS_REPO --branch develop
+bench install-app supportive_help
+```
+
+### Contributing
+
+This app uses `pre-commit` for code formatting and linting. Please [install pre-commit](https://pre-commit.com/#installation) and enable it for this repository:
+
+```bash
+cd apps/supportive_help
+pre-commit install
+```
+
+Pre-commit is configured to use the following tools for checking and formatting your code:
+
+- ruff
+- eslint
+- prettier
+- pyupgrade
+
+### License
+
+mit