Permalink
Browse files

README updated: tried to make it less confusing on some parts

see issue: #17
  • Loading branch information...
pgericson committed May 20, 2012
1 parent 1c4ae79 commit 9f961ce0c3e1c10cbdeb1e1884b309d75e74eb62
Showing with 6 additions and 5 deletions.
  1. +6 −5 README.markdown
View
@@ -29,12 +29,13 @@ and outputs json
z = Zendesk::Main.new('subdomain', 'username', 'password', :format => 'json')
-For the most part all functions is based on the following functions
-REST function_names = %{user, organization, group, ticket,attachement, tag, forum, entries, search}
-
### Show
z.get_function_name(user_id)
+
+where function_name is one the following:
+user, organization, group, ticket, attachement, tag, forum, entries, search
+
e.g.
z.get_user(121)
@@ -48,10 +49,10 @@ e.g.
### Create
with string
- z.create_function_name("<user><email>email@company.com</email><name>John Doe</name></user>")
+ z.create_user("<user><email>email@company.com</email><name>John Doe</name></user>")
with hash(array is not supported yet)
- z.create_function_name({:email => 'email@company.com', :name => 'John Doe'})
+ z.create_user({:email => 'email@company.com', :name => 'John Doe'})
### Update
Not supported yet

0 comments on commit 9f961ce

Please sign in to comment.