(docs) update docs

khalby786 · Jul 23, 2020 · 3f0c017 · 3f0c017
1 parent aaa53f0
commit 3f0c017
Show file tree

Hide file tree

Showing 5 changed files with 98 additions and 63 deletions.
diff --git a/README.md b/README.md
@@ -1,14 +1,14 @@
 ![jsoning](https://cdn.glitch.com/53ed8404-b30d-494a-8960-e28bf8781ebd%2Fjsoning-text.png?v=1595495853462)
 
-<center>
+<div align="center>
 
 # jsoning
 
 ✨ A simple key-value JSON-based persistent lightweight database. ✨
 
-</center>
+</div>
 
-<center>
+<div align="center">
 
 ![CodeCov](https://codecov.io/gh/khalby786/jsoning/branch/master/graph/badge.svg)
 [![Build Status](https://travis-ci.org/khalby786/jsoning.svg?branch=master)](https://travis-ci.org/khalby786/jsoning)
@@ -27,22 +27,22 @@
 ![Website](https://img.shields.io/website?down_color=red&down_message=offline&up_color=green&up_message=online&url=https%3A%2F%2Fkhalby786.github.io%2Fjsoning)
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkhalby786%2Fjsoning.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkhalby786%2Fjsoning?ref=badge_shield)
 
-</center>
+</div>
 
-<center>
+<div align="center">
 
 ![Twitter URL](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fkhalby786.github.io%2Fjsoning)
 ![Twitter Follow](https://img.shields.io/twitter/follow/khalby786?style=social)
 
-</center>
+</div>
 
-<center>
+<div align="center">
 
 [View Demo](https://glitch.com/edit/#!/jsoning) · [Report Bug](https://github.com/khalby786/jsoning/issues) · [Request Feature](https://github.com/khalby786/jsoning/issues)
 
 Loved the project? Please consider [donating](https://buymeacoffee.com/khaleelgibran) to help it improve!
 
-</center>
+</div>
 
 
 | **Like us a lot?** Help others know why you like us! **Review this package on [pkgreview.dev](https://pkgreview.dev/npm/jsoning)** | ➡   | [![Review us on pkgreview.dev](https://i.ibb.co/McjVMfb/pkgreview-dev.jpg)](https://pkgreview.dev/npm/jsoning) |             

diff --git a/docs/CNAME b/docs/CNAME
diff --git a/docs/content/readme.html b/docs/content/readme.html
@@ -1,26 +1,53 @@
 
-<html><head></head><body><h1 id="jsoning">jsoning</h1>
+<html><head></head><body><p><img src="https://cdn.glitch.com/53ed8404-b30d-494a-8960-e28bf8781ebd%2Fjsoning-text.png?v=1595495853462" alt="jsoning" style="max-width: 100%;"></p>
+<p>&lt;div align="center&gt;
+
+</p>
+<h1 id="jsoning">jsoning</h1>
 <hr />
+<p>✨ A simple key-value JSON-based persistent lightweight database. ✨</p>
+<p>&lt;/div&gt;
+
+</p>
+<p>&lt;div align="center"&gt;
+
+</p>
 <p><img src="https://codecov.io/gh/khalby786/jsoning/branch/master/graph/badge.svg" alt="CodeCov" style="max-width: 100%;">
 <a href="https://travis-ci.org/khalby786/jsoning"><img src="https://travis-ci.org/khalby786/jsoning.svg?branch=master" alt="Build Status" style="max-width: 100%;"></a>
 <a href="https://github.com/khalby786/jsoning"><img src="https://img.shields.io/github/forks/khalby786/jsoning.svg" alt="Build Status" style="max-width: 100%;"></a>
 <a href="https://github.com/khalby786/jsoning"><img src="https://img.shields.io/github/stars/khalby786/jsoning.svg" alt="Build Status" style="max-width: 100%;"></a>
 <a href="https://github.com/khalby786/jsoning"><img src="https://img.shields.io/github/license/khalby786/jsoning.svg" alt="License" style="max-width: 100%;"></a>
 <a href="https://www.npmjs.com/package/jsoning"><img src="https://img.shields.io/npm/v/jsoning.svg" alt="Latest Stable Version" style="max-width: 100%;"></a>
-<a href="https://www.npmjs.com/package/jsoning"><img src="https://img.shields.io/npm/l/jsoning.svg" alt="License" style="max-width: 100%;"></a>
 <a href="https://www.npmjs.com/package/jsoning"><img src="https://img.shields.io/npm/dt/jsoning.svg" alt="NPM Downloads" style="max-width: 100%;"></a>
 <a href="https://www.npmjs.com/package/jsoning"><img src="https://img.shields.io/npm/dm/jsoning.svg" alt="NPM Downloads" style="max-width: 100%;"></a>
 <img src="https://img.shields.io/pkgreview/rating/npm/jsoning" alt="Pkgreview.dev Reviews" style="max-width: 100%;">
-<img src="https://img.shields.io/pkgreview/stars/npm/jsoning" alt="Pkgreview.dv Stars" style="max-width: 100%;">
 <img src="https://img.shields.io/librariesio/release/npm/jsoning" alt="Libraries.io dependency status for latest release" style="max-width: 100%;">
 <img src="https://img.shields.io/discord/698841420412354581" alt="Discord" style="max-width: 100%;">
 <img src="https://img.shields.io/bundlephobia/min/jsoning" alt="npm bundle size" style="max-width: 100%;">
 <img src="https://img.shields.io/github/repo-size/khalby786/jsoning" alt="GitHub repo size" style="max-width: 100%;">
 <img src="https://img.shields.io/node/v/jsoning" alt="node-current" style="max-width: 100%;">
 <img src="https://img.shields.io/website?down_color=red&amp;down_message=offline&amp;up_color=green&amp;up_message=online&amp;url=https%3A%2F%2Fkhalby786.github.io%2Fjsoning" alt="Website" style="max-width: 100%;">
 <a href="https://app.fossa.com/projects/git%2Bgithub.com%2Fkhalby786%2Fjsoning?ref=badge_shield"><img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkhalby786%2Fjsoning.svg?type=shield" alt="FOSSA Status" style="max-width: 100%;"></a></p>
+<p>&lt;/div&gt;
+
+</p>
+<p>&lt;div align="center"&gt;
+
+</p>
 <p><img src="https://img.shields.io/twitter/url?style=social&amp;url=https%3A%2F%2Fkhalby786.github.io%2Fjsoning" alt="Twitter URL" style="max-width: 100%;">
 <img src="https://img.shields.io/twitter/follow/khalby786?style=social" alt="Twitter Follow" style="max-width: 100%;"></p>
+<p>&lt;/div&gt;
+
+</p>
+<p>&lt;div align="center"&gt;
+
+</p>
+<p><a href="https://glitch.com/edit/#!/jsoning">View Demo</a> · <a href="https://github.com/khalby786/jsoning/issues">Report Bug</a> · <a href="https://github.com/khalby786/jsoning/issues">Request Feature</a></p>
+<p>Loved the project? Please consider <a href="https://buymeacoffee.com/khaleelgibran">donating</a> to help it improve!</p>
+<p>&lt;/div&gt;
+
+
+</p>
 <table>
 <thead>
 <tr>
@@ -30,8 +57,8 @@
 </tr>
 </thead>
 </table>
-<p><img src="https://cdn.glitch.com/c393fad9-338a-43b4-9a2f-8ba07e26d39d%2Fjsoning.png?v=1589190601684" alt="jsoning" style="max-width: 100%;"></p>
-<p>✨ A simple key-value JSON-based persistent lightweight database. ✨</p>
+<h2 id="features">Features</h2>
+<hr />
 <ul>
 <li>📝 Uses JSON files to modify and write key-value elements as JSON-objects.</li>
 <li>👌 <strong>Easy to use</strong> JSON database.</li>
@@ -44,7 +71,7 @@ <h2 id="install---">Install 💾</h2>
 <hr />
 <p><strong>Node.js v12.x or greater is required for this package to work.</strong></p>
 <pre><code class="js">npm install jsoning</code></pre>
-<p>View the full documentation <a href="https://khalby786.github.io/jsoning/">here</a>.</p>
+<p>View the full documentation <a href="https://jsoning.js.org/">here</a>.</p>
 <h2 id="basic-usage---">Basic Usage 📑</h2>
 <hr />
 <pre><code class="js">let jsoning = require('jsoning');
@@ -59,16 +86,17 @@ <h2 id="basic-usage---">Basic Usage 📑</h2>
 <h2 id="links---">Links 🔗</h2>
 <hr />
 <ul>
-<li><a href="https://khalby786.github.io/jsoning">Documentation</a></li>
-<li><a href="https://jsoning.js.org">Guide</a></li>
+<li><a href="https://jsoning.js.org">Documentation</a></li>
+<li><a href="https://jsoning.netlify.app">Guide</a></li>
 <li><a href="https://github.com/khalby786/jsoning">GitHub</a></li>
 <li><a href="https://discord.gg/3v8P9RE">Discord</a></li>
 <li><a href="https://glitch.com/~jsoning">Glitch</a></li>
 </ul>
+<h2 id="contributing">Contributing</h2>
+<hr />
+<p>Please see <code>CONTRIBUTING.md</code> for more details on contributing!</p>
 <h2 id="license">License</h2>
 <hr />
 <p>This package is open sourced under the <a href="https://github.com/khalby786/jsoning/blob/master/LICENSE.md">MIT License</a>.</p>
 <p><a href="https://app.fossa.com/projects/git%2Bgithub.com%2Fkhalby786%2Fjsoning?ref=badge_large"><img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkhalby786%2Fjsoning.svg?type=large" alt="FOSSA Status" style="max-width: 100%;"></a></p>
-<hr>
-<p>If you would like to support my projects, consider buying me a donut at <a href="https://www.buymeacoffee.com/khaleelgibran">https://www.buymeacoffee.com/khaleelgibran</a>.</p>
 </body></html>