From bece4cdcf2c35ec2b1c53dca2d569deac50e6c7e Mon Sep 17 00:00:00 2001
From: Nikita Karamov
Date: Sun, 26 Jul 2020 14:40:37 +0200
Subject: [PATCH] Update docs
---
README.md | 47 +++++++++++++++++++++++++++++++++++---
docs/index.html | 60 +++++++++++++++++++++++++++++++++++++++++++------
2 files changed, 97 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 1ce751a..071bfdb 100644
--- a/README.md
+++ b/README.md
@@ -18,8 +18,8 @@ Observe the live demo here: [shareon.js.org](https://shareon.js.org)
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:
@@ -31,7 +31,48 @@ yarn add shareon
```
```js
-require('shareon');
+const shareon = require('shareon');
+// or
+import shareon from 'shareon';
+```
+
+## Initialization
+
+By default, shareon will initialize every button after page load. It also
+exports the `shareon` function, that will let you repopulate your buttons with
+updated information (for example, if you changed the page title):
+
+```js
+// shareon auto-initializes
+
+window.title = "Cool new window title";
+shareon();
+```
+
+If you want to postpone the initialization, you can import the `noinit`-version
+of the package. You'll need to manually call the `shareon` function when you
+want the buttons to be initialized:
+
+```html
+
+
+
+
+
+```
+
+or, if you're using Node:
+
+```js
+const shareon = require('shareon/dist/noinit/shareon');
+// or
+import shareon from 'shareon/dist/noinit/shareon';
+
+// do something important
+shareon();
```
## Usage
diff --git a/docs/index.html b/docs/index.html
index cfa568e..e425142 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -103,14 +103,60 @@
Include the link to shareon's JS and CSS in your website:
or install it via NPM use it in a JS file that you will later bundle:
-
require('shareon');
-
import 'shareon';
+
or install it via NPM and use it in a JS file that you will later bundle:
+
const shareon = require('shareon');
+
import shareon from 'shareon';
+
+
+
+
+
+ Initialization
+
+
+ By default, shareon will initialize every button after page load.
+ It also exports the shareon function, that will let
+ you repopulate your buttons with updated information (for example,
+ if you changed the page title):
+
+ If you want to postpone the initialization, you can import the
+ noinit-version of the package. You'll need to
+ manually call the shareon function when you want the
+ buttons to be initialized:
+
+
<!-- notice the 'noinit' section of the url for JS -->
+<script src="https://cdn.jsdelivr.net/npm/shareon@1.3/dist/shareon.min.js"
+ type="text/javascript"></script>
+<link href="https://cdn.jsdelivr.net/npm/shareon@1.3/dist/shareon.min.css"
+ rel="stylesheet">
+
+<script type="text/javascript">
+ // do something important
+ shareon();
+</script>
+
+
+ or, if you're using Node:
+
+
+
const shareon = require('shareon');
+// or
+import shareon from 'shareon';
+
+// do something important
+shareon();