Updated README for running client side code.
With changes from gerrit comments.
Change-Id: I6070701db2c04df5c71c2fa36c3175157ad6f007
diff --git a/README.md b/README.md
index 2c87492..635f240 100644
--- a/README.md
+++ b/README.md
@@ -231,24 +231,5 @@
Starting front end
------------------
-* Open the client folder in ndn-atmos
+Please see the README in client folder.
-* Checkout the ndn-js in the client folder. Use the link blow:
-
-<pre>
- git clone http://github.com/named-data/ndn-js.git
- cd ndn-js
- git checkout v0.8.1
-</pre>
-
-* Start python simple server in the client folder (ndn-atmos/client)
-
-<pre>
- python -m SimpleHTTPServer
-</pre>
-
-* Open project query page in a web browser
-
-<pre>
- http://localhost:8000/query/query.html
-</pre>
diff --git a/client/README.md b/client/README.md
index 0882445..ebf8aac 100644
--- a/client/README.md
+++ b/client/README.md
@@ -6,34 +6,44 @@
Setup
-----
-To setup the site including the production folder simply run `./autogen.sh`
+Simply run a webserver on THIS directory (aka
+.../ndn-atmos/client) and point clients to /catalog on either the domain or
+IP that the server is running on.
-The site will now be available in the catalog directory.
+Good suggestions are http-server in npm, pythons SimpleHTTPServer, or a standard
+webserver like nginx or apache.
-If you run into issues of requiring sudo access you may need to [configure the npm prefix](http://competa.com/blog/2014/12/how-to-run-npm-without-sudo/) to point your global package repo somewhere else. Should you find yourself in a situation that you don't mind using sudo, feel free to simply just run with sudo.
-
-##Serving the site:
-
-To serve the site, point a webserver at the same directory this README file is in. Then give users the url: http://<your domain>/catalog or /catalog-dev depending on if you are running deployment code.
-
-HTTPS is not supported and will break the code as it is unless the ndn backend is running a valid certificate as well, this is due to a security rule in most browsers that restricts the ws protocol from running in https tabs/frames. All content in the https frame MUST be secure. (Aka run wss in https) (HTTPS is not officially supported)
+__Note:__
+HTTPS is not supported unless the ndn websocket server is running a valid
+certificate as well as the web server. This is due to a security rule in most
+browsers that restricts the ws protocol from running in https tabs/frames. All
+content in the https frame MUST be secure including the websocket.
+(HTTPS is untested at this time but you can ask questions on the mailing list
+if you have problems.)
config.json
-----------
###Global
-* CatalogPrefix - Where should the catalog attach in the URI scheme? (Usually the root of a catalog)
+* CatalogPrefix - Where should the catalog attach in the URI scheme? (Usually the
+root of a catalog)
* FaceConfig - A valid NDN node location running the websocket for NDN-JS.
###Retrieval
-* DemoKey - The public and private portion of an RSA in Base64. This key must be valid in the NDN Network for it to work.
-* Destinations - A list of retrieval URIs. These must be running the retrieval code or retrieval will fail.
+* DemoKey - The public and private portion of an RSA in Base64. This key must be
+valid in the NDN Network for it to work.
+* Destinations - A list of retrieval URIs. These must be running the retrieval
+code or retrieval will fail.
Changing the theme
------------------
-Currently the theme is a modified bootstrap theme that is running larger fonts and custom colors.
+Currently the theme is a modified bootstrap theme that is running larger fonts
+and custom colors.
-If you would like to modify the theme go to [this url](http://bootstrap-live-customizer.com/). To modify the current theme, then upload the variables.less in this folder, make your modifications, and overwrite the variables.less file when you are done (and the theme.min.css).
+If you would like to modify the theme go to [this url](http://bootstrap-live-customizer.com/).
+To modify the current theme, then upload the variables.less in this folder, make
+your modifications, and overwrite the variables.less file when you are done
+(and the theme.min.css).