README.md in fanswatch-0.1.2 vs README.md in fanswatch-0.1.3
- old
+ new
@@ -1,7 +1,55 @@
# FansWatch
+[](https://badge.fury.io/rb/fanswatch)
+[](https://travis-ci.org/wtlin1228/FansWatch)
-## It will provide an api for tracing the facebook's pages.
+FaceGroup is a gem that specializes in getting data from public Facebook Pages.
-## Refactor the api to class variables and class methods done.
+## Installation
-## Prepare publishing fanswatch gem now.
+If you are working on a project, add this to your Gemfile: `gem 'fanswatch'`
+
+For ad hoc installation from command line:
+
+```$ gem install fanswatch```
+
+## Setup Facebook Credentials
+
+Please setup your Facebook developer credentials by creating an app profile on Facebook Developer: https://developers.facebook.com – you should get a "client ID" and "client secret".
+
+## Usage
+
+Require FaceGroup gem in your code: `require 'fanswatch'`
+
+Supply your Facebook credentials to our library in one of two ways:
+- Setup environment variables: `ENV[FB_CLIENT_ID]` and `ENV[FB_CLIENT_SECRET]`
+- or, provide them directly to FansWatch:
+
+```
+FansWatch::FbApi.config = { client_id: ENV['FB_CLIENT_ID'],
+ client_secret: ENV['FB_CLIENT_SECRET'] }
+```
+
+See the following example code for more usage details:
+
+```ruby
+# Access the page
+page = FansWatch::Page.find(
+ id: ENV['FB_PAGE_ID']
+)
+
+puts page.name
+
+feed = page.feed
+
+puts feed.count
+
+page.feed.postings.each do |posting|
+ puts posting.id
+ puts posting.created_time
+ puts posting.message
+ if posting.attachment
+ puts posting.attachment.description
+ puts posting.attachment.url
+ end
+end
+```