diff --git a/README.md b/README.md index 55f354f..ec7c904 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,93 @@ # shareon -I'm not shareon maintainer. +Postal Horn emoji -I just publish a specific version waiting my pull request will be merged. +Lightweight, stylish and ethical share buttons. -Check [original repository](https://github.com/NickKaramoff/shareon). \ No newline at end of file +- **Small.** Dependency-free. CSS+JS bundle is only 6 KB minified and gzipped. +- **Stylish.** Uses official vector logos and colors with no visual mess. +- **Ethical.** Embeds no tracking code. JS is required only for the setup. + +shareon example + +---- +Observe the live demo here: [shareon.js.org](https://shareon.js.org) + +## Install + +Include the link to shareon's JS and CSS in your website: + +```html + + +``` + +or install it via NPM use it in a JS file that you will bundle: + +```sh +npm install shareon +# or +yarn add shareon +``` + +```js +require('shareon'); +``` + +## Usage + +> shareon was heavily inspired by [Likely](https://ilyabirman.net/projects/likely/), + and has a backwards-compatible API (excluding themes and sizes). + +Create a container with class `shareon` and populate it with elements, whose +classes match the names of social networks: + +```html +
+ + + + + + + + + + + + +
+``` + +If you use ``, the buttons will get a `href`-attribute to them. In other cases +they will get a listener on `click` event, so you can use `