use Client.new to make a struct

trinity-1686a · Jun 22, 2015 · 184282e · 184282e
1 parent 042554d
commit 184282e
Showing 1 changed file with 13 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -56,7 +56,7 @@ Getting info from a user using a client
 
 ```iex
 iex> client = %Tentacat.Client{}
-Tentacat.Client{auth: nil}
+%Tentacat.Client{auth: nil, endpoint: "https://api.github.com/"}
 iex> Tentacat.Users.find "edgurgel", client
 [{"login","edgurgel"},{"id",30873},{"avatar_url","https://secure.gravatar.com/avatar/5e0f65b214819fedf529220e19c08908?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png"},{"gravatar_id","5e0f65b214819fedf529220e19c08908"},{"url","https://api.github.com/users/edgurgel"},{"html_url","https://github.com/edgurgel"},{"followers_url","https://api.github.com/users/edgurgel/followers"},{"following_url","https://api.github.com/users/edgurgel/following{/other_user}"},{"gists_url","https://api.github.com/users/edgurgel/gists{/gist_id}"},{"starred_url","https://api.github.com/users/edgurgel/starred{/owner}{/repo}"},{"subscriptions_url","https://api.github.com/users/edgurgel/subscriptions"},{"organizations_url","https://api.github.com/users/edgurgel/orgs"},{"repos_url","https://api.github.com/users/edgurgel/repos"},{"events_url","https://api.github.com/users/edgurgel/events{/privacy}"},{"received_events_url","https://api.github.com/users/edgurgel/received_events"},{"type","User"},{"name","Eduardo Gurgel"},{"company","Codeminer 42"},{"blog","http://gurgel.me"},{"location","Fortaleza, Brazil"},{"email","eduardo@gurgel.me"},{"hireable",false},{"bio",nil},{"public_repos",19},{"followers",16},{"following",38},{"created_at","2008-10-24T17:05:04Z"},{"updated_at","2013-06-18T22:52:41Z"},{"public_gists",4}]
 ```
@@ -73,16 +73,24 @@ Getting info from the authenticated user
 * Using user and password:
 
 ```iex
-iex> client = %Tentacat.Client{auth: %{user: "user", password: "password"}}
-Tentacat.Client{auth: %{user: "user", password: "password"}}
+iex> client = Tentacat.Client.new(%{user: "user", password: "password"})
+%Tentacat.Client{auth: %{user: "user", password: "password"}, endpoint: "https://api.github.com/"}
 iex> Tentacat.Users.me(client)
 ```
 
 * Using a personal access token [Github personal API token](https://github.com/blog/1509-personal-api-tokens)
 
 ```iex
-iex> client = %Tentacat.Client{auth: %{access_token: "928392873982932"}}
-Tentacat.Client{auth: %{access_token: "928392873982932"}}
+iex> client = Tentacat.Client.new(%{access_token: "928392873982932"})
+%Tentacat.Client{auth: %{access_token: "928392873982932"}, endpoint: "https://api.github.com/"}
+iex> Tentacat.Users.me(client)
+```
+
+Accessing another endpoint
+
+```iex
+iex> client = Tentacat.Client.new(%{access_token: "928392873982932"}, "https://ghe.example.com/api/v3/")
+%Tentacat.Client{auth: %{access_token: "928392873982932"}, endpoint: "https://ghe.example.com/api/v3/"}
 iex> Tentacat.Users.me(client)
 ```