diff --git a/README.md b/README.md index 4758435..421b4f1 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,68 @@ This is a docsify plugin to render changelog from given path [](https://github.com/standard/standard) - +[](https://www.jsdelivr.com/package/npm/docsify-changelog-plugin) ## Installation +Add the following stylesheet along with your other stylesheets + +```html + + +``` + +And add the following script + +```html + +``` + ## Configure -## Usage +In your docsify config object add the following + +```js +window.$docsify = { +... +changelog : 'CHANGELOG.md' // path of your changelog, it can be remote as well +... +} +``` + +### Thanks it, Now enjoy :tada: your changelog integration with docsify + +## Screen Shot + +
+
+
+
+
+
+