update readme

Author: thierryxing

README.md

@@ -1,36 +1,79 @@
-# Sentry
+# Sentry Ruby API
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sentry`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Sentry Ruby API is a Ruby wrapper for the [getsentry/sentry API](https://docs.sentry.io/hosted/api/). **And it still being developed, and not published yet.**
 
 ## Installation
 
-Add this line to your application's Gemfile:
+add to a Gemfile:
 
 ```ruby
-gem 'sentry'
+gem 'sentry', :path => '/path/to/sentry'
 ```
 
-And then execute:
+## Usage
 
-    $ bundle
+Configuration example:
 
-Or install it yourself as:
+```ruby
+Sentry.configure do |config|
+  config.endpoint = 'http://example.com/api/0'
+  config.auth_token = 'your_auth_token'
+  config.default_org_slug = 'sentry-sc'
+end
+```
 
-    $ gem install sentry
+(Note: If you are using getsentry.com's hosted service, your endpoint will be `https://app.getsentry.com/api/0`)
 
-## Usage
+Usage examples:
 
-TODO: Write usage instructions here
+```ruby
+# set an API endpoint
+Sentry.endpoint = 'http://example.com/api/0'
+# => "http://example.com/api/0"
 
-## Development
+# set a user private token
+Sentry.auth_token = 'your_auth_token'
+# => "your_auth_token"
+
+# configure a proxy server
+Sentry.http_proxy('proxyhost', 8888)
+# proxy server w/ basic auth
+Sentry.http_proxy('proxyhost', 8888, 'user', 'pass')
+
+# list projects
+Sentry.projects
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+# initialize a new client
+s = Sentry.client(endpoint: 'https://api.example.com', auth_token: 'your_auth_token', default_org_slug: 'sentry-sc')
+
+# a paginated response
+projects = Sentry.projects
+
+# check existence of the next page
+projects.has_next_page?
+
+# retrieve the next page
+projects.next_page
+
+# iterate all projects
+projects.auto_paginate do |project|
+  # do something
+end
+
+# retrieve all projects as an array
+projects.auto_paginate
+```
+
+## Development
+The basic framework had been finished, meanwhile the APIs of Organizations,Projects and Events had been added, more APIs will be added later. You are welcome to help me with it.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
 
-## Contributing
+## License
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sentry.
+Released under the BSD 2-clause license. See LICENSE.txt for details.
 
+## Special Thank
+Thanks to NARKOZ's [gitlab](https://github.com/NARKOZ/gitlab) ruby wrapper which really gives me a lot of inspiration.