From: Dan Brown <redacted>
Date: Sun, 12 Feb 2023 23:35:18 +0000 (+0000)
Subject: Added funding and readme files
X-Git-Url: http://source.bookstackapp.com/hacks/commitdiff_plain/069b776e8da8d9d6f58609f2ca1f62cd3eae4c15

Added funding and readme files
---

diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
new file mode 100644
index 0000000..f3f51c7
--- /dev/null
+++ b/.github/FUNDING.yml
@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: [ssddanbrown]
+ko_fi: ssddanbrown
\ No newline at end of file
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..dededda
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,30 @@
+# BookStack Hacks
+
+This repository contains the hacks that are shown on the [/hacks part of the website](https://www.bookstackapp.com/hacks/). This is not a website in itself,
+but it designed to be a submodule within the `hacks/` directory of the [BookStack website repo](https://github.com/BookStackApp/website).
+
+### Support & Issues
+
+Hacks in this repo are unsupported, maybe become out-of-date and do not receive active maintenance unlike the core BookStack codebase. 
+
+Feel free to raise an issue for bugs or incorrect content but **please do not open issues for**:
+
+- Requesting new hacks, or variations of existing hacks.
+- Guidance/support for implementing, using or maintaining hacks.
+- Issues when using hacks on BookStack versions they're not lasted tested for.
+- Providing details to update a hack (Open a PR instead).
+- Limitations in existing hacks.
+
+### Contributions & Scope
+
+Contributions are welcome to this repository but the scope for additions will be relatively strict to keep maintenance dept minimal. Please don't assume any customizations/hacks will be accepted here. The scope will be as follows:
+
+- There should be minimal overlap with an existing hack.
+- The hack should have a relatively minimal surface area.
+- The hack should have a reasonably low chance of conflicting with future updates.
+- The hack should have a low likelihood of inadvertently causing additional problems.
+- Hacks should not have external platform-specific requirements.
+
+Pull requests to update hacks for more recent compatibility are welcome, as long as they don't apply additional non-required changes.
+
+Contributions will become under the MIT license of the project. Note that I may in the future monetize the supply, updating and tweaking of hacks in this repo.
\ No newline at end of file