Skip to content

Commit

Permalink
Update Redme
Browse files Browse the repository at this point in the history
  • Loading branch information
pinceladasdaweb committed Feb 6, 2016
1 parent 044378c commit df3b778
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Socialight get Social Network Share Counts on demand. Specify the url and social

#### And Twitter?

Please, read [here](https://blog.twitter.com/2015/hard-decisions-for-a-sustainable-platform).
Twitter removed share counts, please, read [here](https://blog.twitter.com/2015/hard-decisions-for-a-sustainable-platform).

## Getting Started

Expand All @@ -23,7 +23,7 @@ $ git clone [email protected]:pinceladasdaweb/Socialight.git
In HTML, set the element that will be displayed counters, an example can be seen below:

```html
<div data-socialight-url='YOUR-URL' data-socialight-channels='["facebook", "googleplus", "linkedin", "buffer", "pinterest"]'></div>
<div data-socialight-url='YOUR-URL' data-socialight-title='YOUR-TITLE' data-socialight-text='YOUR-TEXT' data-socialight-image='YOUR-IMAGE' data-socialight-channels='["facebook", "twitter" "googleplus", "linkedin", "buffer", "pinterest"]'></div>
```

Socialight is a [Vanilla JS](http://vanilla-js.com/) plugin with no dependencies. Include the [`socialight.min.js`](build/socialight.min.js) before your ```</body>``` tag and initialise it:
Expand Down Expand Up @@ -51,7 +51,10 @@ The script expect the following attributes in the html tag:

| Value | Description |
| ---------------------------------- |:-----------------------------------------------------------:|
| **data-socialight-url** | The URL to get share counts |
| **data-socialight-url** | The URL to share and get share counts |
| **data-socialight-title** | The title to share |
| **data-socialight-text** | The description link to share |
| **data-socialight-image** | The image url to share |
| **data-socialight-channels** | Social networks to display share counts |

## Supported services
Expand All @@ -73,8 +76,4 @@ Check [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
Check [Releases](https://github.com/pinceladasdaweb/Socialight/releases) for detailed changelog.

## License
[MIT](LICENSE)

## To do

- [ ] Add option to share on social networks
[MIT](LICENSE)

0 comments on commit df3b778

Please sign in to comment.