Add install instructions to README
parent
ff862a9fa3
commit
f4a7fd769d
32
README.md
32
README.md
|
@ -1,10 +1,6 @@
|
||||||
# shareon
|
# shareon
|
||||||
|
|
||||||
<img src="https://raw.githubusercontent.com/googlefonts/noto-emoji/master/png/128/emoji_u1f4ef.png"
|
<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">
|
||||||
align="right"
|
|
||||||
alt="Postal Horn emoji"
|
|
||||||
width="96"
|
|
||||||
height="96">
|
|
||||||
|
|
||||||
Lightweight, stylish and ethical share buttons.
|
Lightweight, stylish and ethical share buttons.
|
||||||
|
|
||||||
|
@ -12,6 +8,32 @@ Lightweight, stylish and ethical share buttons.
|
||||||
- **Stylish.** Uses official vector logos and colors.
|
- **Stylish.** Uses official vector logos and colors.
|
||||||
- **Ethical.** No tracking code is being embedded.
|
- **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">
|
<img src="https://raw.githubusercontent.com/NickKaramoff/shareon/develop/docs/screen01.png" height="60" alt="shareon example">
|
||||||
|
|
||||||
```html
|
```html
|
||||||
|
|
Binary file not shown.
After Width: | Height: | Size: 17 KiB |
Loading…
Reference in New Issue