Browse Source

update README

Outsider 7 years ago
parent
commit
f623f515d2
2 changed files with 23 additions and 5 deletions
  1. 1 0
      .gitignore
  2. 22 5
      README.md

+ 1 - 0
.gitignore

@@ -29,3 +29,4 @@ node_modules
 
 .env
 .env.*
+.idea/

+ 22 - 5
README.md

@@ -8,15 +8,32 @@ Inspired by
 and
 [Socket.io's slack page](http://socket.io/slack/).
 
+This project support Heroku, Azure and Cloud Foundry.
+
 [![Deploy to Heroku](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
 [![Deploy to Azure](http://azuredeploy.net/deploybutton.png)](https://azuredeploy.net/)
 
 ## Settings
 
-##### Local
+You can set variables for your own purpose in `config.js` or environment variables.
+
+### `config.js`
+
+Fill out `config.js` as your infomation.
+
+* `community`: your community or team name to display on join page.
+* `slackUrl` : your slack team url (ex: socketio.slack.com)
+* `slacktoken` : access token of slack.
+  You can generate it in <https://api.slack.com/web#auth>.
+  **You should generate the token in admin user, not owner.**
+  If you generate the token in owner user, `missing_scope` error will be occurred.
+* `inviteToken`: an optional security measure - if it is set, then that token will be required to get invited.
+* `locale`: application language (currently `en`, `de`, `es`, `fr`, `pt`, `pt-BR`, `zh-CN`, `zh-TW`, `ja` and `ko` available).
 
-Create a file in the root called `.env` with the following key/value pairs. `.env`
-files are added to the `.gitignore`.
+### Environment Variables
+You can set environment variables directly or in `.env` file.
+If you want to use a `.env` file, create a file in the root called `.env` with the following key/value pairs.
+(`.env` files are added to the `.gitignore`.)
 
 - `COMMUNITY_NAME` : Your community or team name to display on join page.
 - `SLACK_URL` : Your slack team url (ex: socketio.slack.com)
@@ -45,9 +62,9 @@ You can test your token via curl:
    --compressed
   ```
 
-##### Heroku / Azure
+### Heroku / Azure
 
-Add the application settings that are defined above for the local `.env` file.
+Add the application settings that are defined above enviornment variables.
 
 ## Run
 [Node.js](http://nodejs.org/) is required.