aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..75cbd15
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
1# ferdi-server
2Unofficial Franz server replacement for use with the Ferdi Client.
3
4## Setup
51. Clone this repository
62. Install the [AdonisJS CLI](https://adonisjs.com/)
73. Run the database migrations with
8 ```js
9 adonis migration:run
10 ```
114. Start the server with
12 ```js
13 adonis serve --dev
14 ```
15
16## License
17ferdi-server is licensed under the MIT License \ No newline at end of file