diff options
author | Steven Blowers <shdblowers@gmail.com> | 2016-10-30 18:24:41 +0000 |
---|---|---|
committer | Steven Blowers <shdblowers@gmail.com> | 2016-10-30 18:24:41 +0000 |
commit | 733965d12c5a8c3a4e2db97ba7bdfff5029fe533 (patch) | |
tree | 88b5c2261407dea82f58dac118fb41a5b775b13e | |
parent | 7ed1bfc69b7efd31a04c7fc09cdd6f0432e45131 (diff) | |
download | zendex-733965d12c5a8c3a4e2db97ba7bdfff5029fe533.tar.gz zendex-733965d12c5a8c3a4e2db97ba7bdfff5029fe533.tar.xz |
adding usage docs to readme
-rw-r--r-- | README.md | 20 |
1 files changed, 20 insertions, 0 deletions
@@ -25,3 +25,23 @@ An Elixir wrapper for the Zendesk API. [applications: [:zendex]] end ``` + +## Usage + + 1. Setup a `Zendex.Connection` map, that will store your Zendesk details. It requires the URL of your Zendesk instance, your username and your password. + + ```elixir + iex> conn = Zendex.Connection.set_up("http://test.zendesk.com", "User1", "pass") + %{authentication: "VXNlcjE6cGFzcw==", base_url: "http://test.zendesk.com"} + ``` + + 2. Make use of the other modules to do various actions on your Zendesk. Example of showing a user: + + ```elixir + iex> Zendex.User.show(conn, 1) + %{"user": %{"id": 87, "name": "Quim Stroud", ...}} + ``` + +## Completeness and Contributions + +This package far from complete in terms of utilising all of the Zendesk API, any contributions will be welcome. Please keep the code consistent with what I have already written here. |