Skip to content

Improve details in README #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
olleolleolle wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve details in README #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,23 @@ Broadcast presence on HipChat to Olark, receive messages from Olark on HipChat
$ source venv/bin/activate
$ pip install -r requirements.txt

### Run tests

### Config

Copy src/config-example.py to src/config.py
In the virtualenv environment, use nose to discover and run tests:

$ cp src/config-example.py src/config.py
$ pip install nose
$ nosetests

Create your HipChat API Token (https://hipchat.com/admin/api) with an admin type

Set it in src/config.py (HIPCHAT_TOKEN)
### Config

Change the room name where to send Olark messages (HIPCHAT_ROOMNAME)
Configure environment variables listed in src/config.py.

Change the Olark username and password (OLARK_USERNAME, OLARK_PASSWORD)
* Create a v1 HipChat API Token (https://hipchat.com/admin/api) with an admin type
* Set it in src/config.py (`HIPCHAT_TOKEN`)
* Change the room name where to send Olark messages (`HIPCHAT_ROOMNAME`)
* Change the Olark username and password (`OLARK_USERNAME`, `OLARK_PASSWORD`)

If you deploy on Heroku, installation is automatic, and you only need to scale to a single Worker to start.

### Execute

Expand Down