README.md in yashare-0.1 vs README.md in yashare-0.9
- old
+ new
@@ -1,7 +1,14 @@
# YaShare
+[![Build Status](https://travis-ci.org/andrewgr/yashare.png)](https://travis-ci.org/andrewgr/yashare)
+[![Code Climate](https://codeclimate.com/github/andrewgr/yashare/badges/gpa.svg)](https://codeclimate.com/github/andrewgr/yashare)
+[![Test Coverage](https://codeclimate.com/github/andrewgr/yashare/badges/coverage.svg)](https://codeclimate.com/github/andrewgr/yashare/coverage)
+[![Gem Version](https://badge.fury.io/rb/yashare.svg)](http://badge.fury.io/rb/yashare)
+
+An Action View helper to add Yandex Share buttons to your Rails App.
+
## Installation
Add this line to your application's Gemfile:
gem 'yashare'
@@ -14,10 +21,37 @@
$ gem install yashare
## Usage
-TODO
+Use `yashare` helper in your view code to add the Yandex Share buttons to the page. Without any parameters, this code
+
+ <%= yashare %>
+
+will render this HTML:
+```HTML
+<script charset="utf-8" type="text/javascript" src="//yastatic.net/share/share.js"></script>
+<div class="yashare-auto-init" data-yashareQuickServices="vkontakte,facebook,twitter,lj" data-yashareL10n="ru" data-yashareType="button"></div>
+```
+
+Use `services` option to specify buttons for which services should be displayed. The default services are: `:vkontakte`, `:facebook`, `:twitter`, `:lj`. Supported services: `:blogger`, `:delicious`, `:diary`, `:digg`, `:evernote`, `:facebook`, `:friendfeed`, `:gplus`, `:juick`, `:liveinternet`, `:linkedin`, `:lj`, `:moikrug`, `:moimir`, `:myspace`, `:odnoklassniki`, `:pinterest`, `:surfingbird`, `:tutby`, `:twitter`, `:vkontakte`, `:yazakladki`.
+
+ <%= yashare(services: [:twitter, :facebook]) %>
+
+Use `lang` option to specify the language for the buttons. The default value is `ru`. Supported values: `:az`,
+`:be`, `:en`, `:hy`, `:ka`, `:kk`, `:ro`, `:ru`, `:tr`, `:tt`, `:uk`.
+
+ <%= yashare(lang: :ru) %>
+
+Use `image` option to specify the image for sharing on Pinterest. This option is useful only when `services` option includes `:pinterest`.
+
+ <%= yashare(image: 'http://example.com/i/photo.jpg') %>
+
+Use `type` option to specify the appearance of the buttons. Default value is `:button`. Supported values: `:small`, `:button`, `:link`, `:icon`, `:none`.
+
+ <%= yashare(type: :small) %>
+
+Read Yandex Share button [documentation](https://tech.yandex.ru/share/) (in Russian) for more information.
## Contributing
Your contribution is welcome.