Skip to content

Commit 6b81b58

Browse files
committed
Updated README
1 parent d6295cd commit 6b81b58

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Ruby::Stackoverflow
22

3-
Ruby toolkit to Stackoverflow api
3+
Ruby toolkit to Stackoverflow API
44

55
## Install
6+
67
Add this line to your application's Gemfile:
78

89
gem 'ruby-stackoverflow'
@@ -14,12 +15,26 @@ And then execute:
1415
Or install it yourself as:
1516

1617
$ gem install ruby-stackoverflow
18+
19+
###Documentation
20+
21+
<a href='https://github.com/raysrashmi/ruby-stackoverflow/wiki/Users-calls'>User Calls</a>
22+
<br/>
23+
<a href='https://github.com/raysrashmi/ruby-stackoverflow/wiki/Users-calls'>Questions Calls</a>
24+
<br/>
25+
<a href='https://github.com/raysrashmi/ruby-stackoverflow/wiki/Users-calls'>Badges Calls</a>
26+
<br/>
27+
<a href='https://github.com/raysrashmi/ruby-stackoverflow/wiki/Users-calls'>Badges Calls</a>
28+
<br/>
29+
1730
##Configuration
31+
1832
You can add your key and access-token for higher rate limit.
1933
To get Key and Access Token you have to register your app to http://stackapps.com/
2034
Run command in your application dir.
2135

2236
$ rails generate ruby-stackoverflow --client_key=<key> --access_token=<access token>
37+
2338
This command will create a ruby_stackoverflow.rb file in config/initializers.
2439

2540
## Contributing
@@ -29,3 +44,7 @@ This command will create a ruby_stackoverflow.rb file in config/initializers.
2944
3. Commit your changes (`git commit -am 'Add some feature'`)
3045
4. Push to the branch (`git push origin my-new-feature`)
3146
5. Create new Pull Request
47+
48+
##LICENSE
49+
50+

0 commit comments

Comments
 (0)