Merge branch 'master' of https://github.com/jagenjo/wide.js

README.md

@@ -1,2 +1,48 @@
 # wide.js
-An web IDE (mostly a coding editor) based in monaco (with a one-file server made in php)
+
+WIDE is a Web IDE based in monaco-editor, it allows to edit remote files in your own server quite easily, instead of having to use local files or uploading files through SFTP.
+
+It allows to open several files, to browser remote folders, and the privileges are based in a config.json that you can store server side.
+
+![WIDE preview](wide_preview.PNG "WIDE preview")
+
+It has a layer of security but it is not as safe as I would like to, so do not use it if your code is very sensitive to people trying to hack you.
+
+# usage
+
+Copy all repository files to a folder in your host accessible from HTTP.
+
+Create the ```wide_config.json``` in a folder that is not accessible through HTTP, like ```/home/``` or ```/home/YOUR_USERNAME''':
+
+```json
+{
+ "projects":{
+ "PROJECT_KEY": {
+ "name":"Project1",
+ "folder":"/srv/www/mysite.com/www/public_html/",
+ "play":"https://mysite.com/"
+ },
+ "PROJECT_KEY2": {
+ "name":"Project2",
+ "folder":"/srv/www/mysite2.com/www/public_html/",
+ "play":"https://mysite2.com/"
+ }
+ }
+}
+```
+
+Where ```PROJECT_KEY``` is the key that grants you access to that folder (and all its subfolders).
+
+Once installed, you access the website and set the key typing in the bottom bar:
+```
+key PROJECT_KEY
+```
+
+You can use the buttons on top of the sidebar to browser server files.
+
+## Contact
+
+For any suggestions or comments, you can contact me at [email protected]
+
+
+