readme

README.md

@@ -0,0 +1,41 @@
+# Remixd
+
+Remixd is a tool that intend to be used with [Remix IDE](http://github.com/ethereum/browser-solidity) (aka. Browser-Solidity). It allows a websocket connection between
+`Remix IDE` (web application) and the local computer.
+
+Practically Remix IDE make available a folder shared by Remixd.
+
+More details are explained in this [tutorial](http://remix.readthedocs.io/en/latest/tutorial_remixd_filesystem.html).
+
+Remixd needs `npm` and `node`
+
+## INSTALLATION
+
+`npm install -g remixd`
+
+## HELP SECTION
+
+```
+ Usage: remixd -S <shared folder>
+
+  Provide a two ways connection between the local computer and Remix IDE
+
+  Options:
+
+    -h, --help                  output usage information
+    -S, --shared-folder <path>  Folder to share with Remix IDE
+```
+
+## SHARE A FOLDER
+
+`remixd -S <absolute-path>`
+
+The current user should have `read/write` access to the folder (at least `read` access).
+
+It is important to notice that changes made to the current file in `Remix IDE` are automatically saved to the local computer every 5000 ms. There is no `Save` action. But the `Ctrl-Z` (undo) can be used.
+
+Furthermore :
+ - No copy of the shared folder are kept in the browser storage.
+ - It is not possible to create a file from `Remix IDE` (that might change).
+ - If a folder does not contain any file, the folder will not be displayed in the explorer (that might change).
+ - Symbolic links are not forwarded to Remix IDE.