From d90a20321c2c707003abab629029c48fe3704320 Mon Sep 17 00:00:00 2001
From: Felix Sidokhine <felix.sidokhine@randstad.ca>
Date: Fri, 5 Jun 2020 21:50:07 +0300
Subject: [PATCH] Added readme

Change-Id: If513f3aa8c13f01a1aecb09bba1894f06a3a1488
---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..e9ad003e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+#### JAMS (Jami Account Management Server)
+
+##### Requirements
+
+* JDK 11+
+* maven
+
+##### Building from source
+
+Clone the contents of this repository and run
+
+```
+mvn clean packge
+```
+
+This will create a distribution folder called ``jams`` in the root folder. You can
+then launch the server by running
+
+```java -jar jams-launcher```
+
+If you want to start the server with an SSL certificate and on a port different
+from 8080, then run:
+
+```java -jar jams-launcher 8443 server.pem server.key```
+
+Where the ``pem`` and ``key`` files are a pem encoded certificate and key.
+
+To generate the documentation you will need ``apidoc`` installed on your system.
+This can be completed by running ``npm install -g apidoc``, if for some reason
+that does not work, you can clone their project from : https://github.com/apidoc/apidoc 
+and install it from source.
+
+To build the documentation, change enter the ``jams-server`` directory and simply run:
+
+```apidoc -i src/ -o doc/```
\ No newline at end of file
-- 
GitLab