impreoved readme

This commit is contained in:
coderaiser 2012-11-20 09:18:50 -05:00
parent 8e9df6f3bb
commit 6450c3b3a5
3 changed files with 17 additions and 4 deletions

View file

@ -1,6 +1,6 @@
Cloud Commander [![Build Status](https://secure.travis-ci.org/coderaiser/cloudcmd.png?branch=master)](http://travis-ci.org/coderaiser/cloudcmd)
===============
**Cloud Commander** - two-panels file manager, totally writed on js.
**Cloud Commander** - user friendly cloud file manager.
DEMO:
[cloudfoundry] (http://cloudcmd.cloudfoundry.com "cloudfoundry"),
[appfog] (http://cloudcmd.aws.af.cm "appfog").
@ -80,12 +80,25 @@ All main configuration could be done thrue config.json.
"html" : true,
"img" : false
},
"oauth_client_id" : "891c251b925e4e967fa9", /* github app id */
"oauth_client_secret" : "afe9bed1e810c5dc44c4c2a953fc6efb1e5b0545", /* github app secret */
"show_keys_panel" : true, /* show classic panel with buttons of keys */
"server" : true, /* server mode or testing mode */
"logs" : false, /* logs or console ouput */
"socket" : true /* enable web sockets */
"port" : 80, /* Cloud Commander port */
"ip" : "127.0.0.1" /* Cloud Commander IP */
"ip" : "127.0.0.1", /* Cloud Commander IP */
"rest" : true /* enable rest interface */
}
```
Authorization
---------------
Thru openID Cloud Commander could Authorize clients.
All things that should be done is must be added id and secret of application
from github settings page and added to config.json or env varibles with names:
"oauth_client_id" and "oauth_client_secret" that is more secure way.
Starting
---------------
To start **Cloud Commander** only one command neaded:

View file

@ -9,7 +9,7 @@
},
"oauth_client_id" : "891c251b925e4e967fa9",
"oauth_client_secret" : "afe9bed1e810c5dc44c4c2a953fc6efb1e5b0545",
"show_keys_panel" : true,
"show_keys_panel" : true,
"server" : true,
"logs" : false,
"socket" : true,

View file

@ -1,4 +1,5 @@
#!/bin/sh
npm i recess jshint
echo "jshint server.js client.js cloudcmd.js"
node_modules/jshint/bin/hint --config test/.jshintrc server.js client.js cloudcmd.js
echo "jshint lib/cloudfunc.js lib/client/keyBinding.js"
@ -8,7 +9,6 @@ node_modules/jshint/bin/hint --config test/.jshintrc lib/client/dom.js lib/clien
echo "jshint ./package.json ./config.json"
node_modules/jshint/bin/hint --config test/.jshintrc ./package.json ./config.json
#linting css files
npm i recess
echo "recess css/*.css"
./node_modules/recess/bin/recess css/*.css
node test/test.js