README.md in googleplus-reader-0.0.5 vs README.md in googleplus-reader-0.0.6
- old
+ new
@@ -1,11 +1,11 @@
# GooglePlus Reader [](http://badge.fury.io/rb/googleplus-reader)
-A library for reading public posts of a [Google+](https://plus.google.com)
-user. A life demo can be found [here](http://photography.ivanukhov.com) and
-its source code [here](https://github.com/IvanUkhov/photography). Best enjoyed
-responsibly.
+The library provides an interface for reading public activities of a
+[Google+](https://plus.google.com) user. A life demo can be found
+[here](http://photography.ivanukhov.com) and its source code
+[here](https://github.com/IvanUkhov/photography). Best enjoyed responsibly.
## Installation
In `Gemfile`:
@@ -57,14 +57,13 @@
reader.next(5).done (posts) ->
console.log(post) for post in posts
```
Here `user_id` is the identifier of a Google+ user, and `api_key` is your
-[Google+ API key](https://developers.google.com/+/api/oauth).
-`post` is exactly what Google has to say about each post without any
-additional preprocessing. You might want to inspect it and fetch what is
-needed for your application.
+[Google+ API key](https://developers.google.com/+/api/oauth). `post` is exactly
+what Google has to say about each post without any additional preprocessing.
+You might want to inspect it and fetch what is needed for your application.
A more interesting example with photos that a user publishes:
```coffee
//= require googleplus.photo
@@ -75,14 +74,14 @@
reader.next(5).done (photos) ->
console.log(photo.attributes) for photo in photos
```
-`photo` is an instance of `GooglePlus.Photo`. Right now, `attributes`
-contain only `url`, `date`, and `width` (if available), but other parameters
-can be easily added via a pull request >:)~ The only method that `photo`
-has is `load`, which can be used as follows:
+`photo` is an instance of `GooglePlus.Photo`. Right now, `attributes` contains
+only `url`, `date`, and `width` (if available), but other parameters can be
+easily added via a pull request >:)~ The only method that `photo` has is
+`load`, which can be used as follows:
```coffee
photo.load().done (element) ->
$('#original').append(element)
@@ -97,12 +96,8 @@
it using an `img` element, which is passes to `done` once the photo has been
loaded.
## Contributing
-1. [Fork](https://help.github.com/articles/fork-a-repo) the project.
-2. Create a branch for your feature (`git checkout -b awesome-feature`).
-3. Implement your feature (`vim`).
-4. Commit your changes (`git commit -am 'Implemented an awesome feature'`).
-5. Push to the branch (`git push origin awesome-feature`).
-6. [Create](https://help.github.com/articles/creating-a-pull-request)
- a new Pull Request.
+1. Fork the project.
+2. Implement your idea.
+3. Create a pull request.