Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README to document new layout and installation instructions. 

(imported from commit ba4d8c4db31ef572b53f49b6792b926236bea553)
This commit is contained in:
Luke Faraone 2013-01-31 15:58:34 -05:00
parent 0e4f1b6d24
commit 8e0ed8eb07
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
api/README
View File

@ -5,6 +5,13 @@ The Humbug API Python bindings require the following Python libraries:
* simplejson * simplejson
* requests (version >= 0.12 and << 1.0.0) * requests (version >= 0.12 and << 1.0.0)
#### Installing
This package uses distutils, so you can just run:
python setup.py install
#### Using the API #### Using the API
For now, the only fully supported API operation is sending a message. For now, the only fully supported API operation is sending a message.
@ -13,7 +20,7 @@ please make sure we know you're using them so that we can notify you
as we make any changes to them. as we make any changes to them.
The easiest way to use these API bindings is to base your tools off The easiest way to use these API bindings is to base your tools off
of the example tools under api/examples in this distribution. of the example tools under examples/ in this distribution.
If you place your API key in `~/.humbugrc` the Python API bindings will If you place your API key in `~/.humbugrc` the Python API bindings will
automatically read it in. The format of the config file is as follows: automatically read it in. The format of the config file is as follows:
@ -56,7 +63,7 @@ msg will describe what went wrong.
#### Sending messages #### Sending messages
You can use the included `api/bin/humbug-send` script to send messages via the You can use the included `humbug-send` script to send messages via the
API directly from existing scripts. API directly from existing scripts.
humbug-send hamlet@example.com cordelia@example.com -m \ humbug-send hamlet@example.com cordelia@example.com -m \