aboutsummaryrefslogtreecommitdiff
path: root/Readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'Readme.md')
-rw-r--r--Readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..84c1a32
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,21 @@
+# Ticker-Counter - Einfache Webseite zur Koordination von Hilfe Tickets
+
+Die helfende Person kann unter `/?admin` oder mit Hilfe des `/done` Endpoints
+das aktuelle Ticket als erledigt markieren.
+
+Hilfesuchende Personen können durch einen klick auf den Hilfebuttons oder
+mit dem `/new` Endpoint ein neues Ticket anfordern.
+
+## Usage
+
+Da ticket-counter in Go geschrieben ist, kann das Binary einfach ausgeführt werden.
+`$ ./ticket-counter` oder unter Windows `$ ./ticket-counter.exe`.
+
+## Lizenz
+
+ticket-counter is licensed under the terms of the GNU General Public License 3.0.
+A copy of the License can be found in the LICENSE file or at
+https://www.gnu.org/licenses/gpl-3.0.en.html.
+
+
+