diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 10 |
1 files changed, 10 insertions, 0 deletions
@@ -8,6 +8,8 @@ An Elixir wrapper for the Zendesk API. +[ExDoc Documentation](https://hexdocs.pm/zendex) + ## Installation 1. Add `zendex` to your list of dependencies in `mix.exs`: @@ -42,6 +44,14 @@ An Elixir wrapper for the Zendesk API. %{"user": %{"id": 87, "name": "Quim Stroud", ...}} ``` + 3. Using pipes: + + ```elixir + "http://test.zendesk.com" + |> Zendex.Connection.setup("Username1", "password123") + |> Zendex.User.show(101) + ``` + ## 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. |