Adds unfinished README

2022-02-18 00:57:08 +01:00 · 2022-02-18 00:57:08 +01:00 · 0791148dc0
commit 0791148dc0
parent d331612d51
1 changed files with 12 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,12 @@
+# Paid signs
+
+The paid-signs plugin is a plugin that lets you add costs for creating plugin signs. This allows restricting usage of
+signs such as CraftBook's gate/lift and other signs while still allowing every player to use the signs.
+
+## Limitations
+
+As this plugin only listens to sign change events, there are some limitations:
+
+1. The plugin is not aware of whether the creation of a sign is successful
+2. It is assumed that any protection plugins run before this plugin, but it's not guaranteed
+3. Plugins changing the lines on signs when successful might create confusion and mismatches