Skip to content
This repository
Browse code

Merge pull request #360 from coreyhaines/add_quickstart_guide_to_top_…

…of_readme

It helps if the README has a clear, immediate Quick Start To Tweeting!
  • Loading branch information...
commit e92a08403f0e29448d322530cd7802ef68cd81f3 2 parents c02534a + afc24ee
Erik Michaels-Ober authored March 06, 2013

Showing 1 changed file with 21 additions and 0 deletions. Show diff stats Hide diff stats

  1. 21  README.md
21  README.md
Source Rendered
@@ -35,6 +35,27 @@ gem in version 0.5.0 and now exists as a [separate project][t].
35 35
 [removed]: https://github.com/sferik/twitter/commit/dd2445e3e2c97f38b28a3f32ea902536b3897adf
36 36
 [t]: https://github.com/sferik/t
37 37
 
  38
+## Quick Start Guide
  39
+
  40
+So you want to get up and tweeting as soon as possible?
  41
+
  42
+First, set up your authentication (you get this from twitter)
  43
+```ruby
  44
+Twitter.configure do |config|
  45
+  config.consumer_key = YOUR_CONSUMER_KEY
  46
+  config.consumer_secret = YOUR_CONSUMER_SECRET
  47
+  config.oauth_token = YOUR_OAUTH_TOKEN
  48
+  config.oauth_token_secret = YOUR_OAUTH_TOKEN_SECRET
  49
+end
  50
+```
  51
+
  52
+Second, tweet away!
  53
+```ruby
  54
+Twitter.update("I'm tweeting from the twitter gem!")
  55
+```
  56
+
  57
+For more detailed information, keep reading!
  58
+
38 59
 ## Documentation
39 60
 [http://rdoc.info/gems/twitter][documentation]
40 61
 

0 notes on commit e92a084

Please sign in to comment.
Something went wrong with that request. Please try again.