Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Crabar committed Aug 22, 2016
1 parent 7aa11c5 commit 24f3b69
Showing 1 changed file with 34 additions and 9 deletions.
43 changes: 34 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,39 @@ The main purpose of this addon to provide possibility to share links with images
ember install ember-social-share

## Usage
Need to update...
There are two ways to embed share buttons to page.
First, you can add share buttons one by one. Example:

{{#fb-share-button}}Share{{/fb-share-button}}
{{#vk-share-button}}Share{{/vk-share-button}}
{{#twitter-share-button}}Tweet{{/twitter-share-button}}

Or you can add share buttons like one share panel:

{{share-panel buttons="fb,vk,twitter" labels="Share,Share,Tweet"}}

There are some properties for ```share-panel```:

* _buttons_ - comma-separated list of social networks
* _labels_ - comma-separated list of buttons labels

At section below you can find share options that can be set for each button or panel.

## Options
Option | Facebook | VKontakte | Twitter
------ | -------- | --------- | -------
url | :white_check_mark: | :white_check_mark: | :white_check_mark:
title | :white_check_mark: | :white_check_mark: | :white_check_mark:
text | :white_check_mark: | :white_check_mark: | :x:
image | :white_check_mark: | :white_check_mark: | :x:
hashtags | :x: | :x: | :white_check_mark:
via | :x: | :x: | :white_check_mark:
Option | Description | Facebook | VKontakte | Twitter
------ | ----------- | -------- | --------- | -------
url | page url (by default - current page url) | ✓ | ✓ | ✓
title | share title (tweet message for twitter) | ✓ | ✓ | ✓
text | description | ✓ | ✓ | ✕
image | image url | ✓ | ✓ | ✕
hashtags | comma-separated list of hashtags | ✕ | ✕ | ✓
via | link to twitter account | ✕ | ✕ | ✓

## Example

{{#fb-share-button url="http://example.com" title="Here is example!" text="Some description..."}}Share{{/fb-share-button}}
{{#vk-share-button title="Some russion title!" text="Another description" image="some image url"}}Share it!{{/vk-share-button}}
{{twitter-share-button title="Look at this!" url="http://example.com" hashtags="example" via="example.com"}}Tweet{{/twitter-share-button}}


{{share-panel title="Example title" text="Example text!" image="sorry didnt find any image" hashtags="example"}}

0 comments on commit 24f3b69

Please sign in to comment.