Initial commit
Change-Id: Ifc297dd3b5a52bb42d79a08bac4d05c2400ae779
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..b1a8451
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,41 @@
+# Jami-Jass
+
+Jami-Jass is a web server that starts a Dameon on NodeJS express server and serve a React web client.
+
+The first milestone is to allow user with LDAP credentials to connect to the account using JAMS service and start chatting with their contacts using instant messaging.
+
+Next step will be to implement a video protocol such as WebRTC to allow audio and video calls from the users browser to another Jami contact allowing crossplateform communications.
+
+# Main dependencies
+
+Jami deamon (https://review.jami.net/admin/repos/ring-daemon)
+
+Jami node js interface (https://review.jami.net/admin/repos/ring-daemon)
+
+Node JS
+
+React
+
+Webpack
+
+Babel
+
+npm install -g node-gyp
+
+For the rest of the dependencies see package.json
+
+# How to start the server
+
+After building the Jami daemon you can use the following command to start the node js server using the LD_LIBRARY_PATH
+
+Where $PATH_TO_JAMI_PROJECT is the path to the shared library of your Jami daemon
+
+LD_LIBRARY_PATH=$PATH_TO_JAMI_PROJECT/ring-project/install/daemon/lib node
+
+To build the dring.node Javascript interface to talk to the daemon api go to the daemon repo and use ./configure --with-nodejs then execute make -j4 to build the daemon
+
+Make sure that the Makefile.ma is configured to build the Swig interfaces with the right nodejs version:
+
+node-gyp configure --target=4.0.0 --arch=x64 --dist-url=https://atom.io/download/electron
+
+