Add install instructions to README

This commit is contained in:
Nikita Karamov 2020-03-26 00:38:54 +01:00
parent ff862a9fa3
commit f4a7fd769d
No known key found for this signature in database
GPG Key ID: E40DFE6E993540FF
2 changed files with 27 additions and 5 deletions

View File

@ -1,10 +1,6 @@
# shareon
<img src="https://raw.githubusercontent.com/googlefonts/noto-emoji/master/png/128/emoji_u1f4ef.png"
align="right"
alt="Postal Horn emoji"
width="96"
height="96">
<img src="https://raw.githubusercontent.com/googlefonts/noto-emoji/master/png/128/emoji_u1f4ef.png" align="right" alt="Postal Horn emoji" width="96" height="96">
Lightweight, stylish and ethical share buttons.
@ -12,6 +8,32 @@ Lightweight, stylish and ethical share buttons.
- **Stylish.** Uses official vector logos and colors.
- **Ethical.** No tracking code is being embedded.
<img src="https://raw.githubusercontent.com/NickKaramoff/shareon/develop/docs/screen01@2x.png" height="114" alt="shareon example">
----
Observe the live demo here: [os.karamoff.dev/shareon](https://os.karamoff.dev/shareon)
## Install
Include the link to shareon's JS and CSS in your website:
```html
<link href="https://cdn.jsdelivr.net/npm/shareon@1/dist/shareon.min.css" rel="stylesheet">
<script src="https://cdn.jsdelivr.net/npm/shareon@1/dist/shareon.min.js" type="text/javascript"></script>
```
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');
```
<img src="https://raw.githubusercontent.com/NickKaramoff/shareon/develop/docs/screen01.png" height="60" alt="shareon example">
```html

BIN
docs/screen01@2x.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB