Better readme

kevduc · Apr 25, 2021 · 4b2b578 · 4b2b578
1 parent 1f71e09
commit 4b2b578
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,11 @@
 # diophantine
-[![npm-publish](https://github.com/kevduc/diophantine/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/kevduc/diophantine/actions/workflows/npm-publish.yml)
 
-Solve linear diophantine equations.
+[![npm-package](https://img.shields.io/npm/v/diophantine?style=plastic)](https://www.npmjs.com/package/diophantine)
+[![npm-downloads](https://img.shields.io/npm/dt/diophantine?label=npm%20downloads&style=plastic)](https://www.npmjs.com/package/diophantine)
+[![build](https://img.shields.io/github/workflow/status/kevduc/diophantine/npm-publish?style=plastic)](https://github.com/kevduc/diophantine/actions/workflows/npm-publish.yml)
+[![last-commit](https://img.shields.io/github/last-commit/kevduc/diophantine?style=plastic)](https://github.com/kevduc/diophantine/commits/main)
+
+Solve linear diophantine equations ax + by = c
 
 **npm**  
 **`npm i diophantine`**  

diff --git a/docs/global.html b/docs/global.html
@@ -776,7 +776,7 @@ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.htm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sat Apr 24 2021 05:08:58 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sun Apr 25 2021 10:33:13 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/index.html b/docs/index.html
@@ -44,9 +44,18 @@ <h3> </h3>
 
     <section>
         <article><h1>diophantine</h1>
-<p>Solve linear diophantine equations.</p>
-<p><strong>Documentation:</strong> <a href="https://kevduc.github.io/diophantine/">kevduc.github.io/diophantine</a></p>
-<p><strong>GitHub repository:</strong> <a href="https://github.com/kevduc/diophantine">kevduc/diophantine</a></p>
+<p><a href="https://www.npmjs.com/package/diophantine"><img src="https://img.shields.io/npm/v/diophantine?style=plastic" alt="npm-package"></a>
+<a href="https://www.npmjs.com/package/diophantine"><img src="https://img.shields.io/npm/dt/diophantine?label=npm%20downloads&amp;style=plastic" alt="npm-downloads"></a>
+<a href="https://github.com/kevduc/diophantine/actions/workflows/npm-publish.yml"><img src="https://img.shields.io/github/workflow/status/kevduc/diophantine/npm-publish?style=plastic" alt="build"></a>
+<a href="https://github.com/kevduc/diophantine/commits/main"><img src="https://img.shields.io/github/last-commit/kevduc/diophantine?style=plastic" alt="last-commit"></a></p>
+<p>Solve linear diophantine equations ax + by = c</p>
+<p><strong>npm</strong><br>
+<strong><code>npm i diophantine</code></strong><br>
+<a href="https://www.npmjs.com/package/diophantine">npmjs.com/diophantine</a></p>
+<p><strong>Documentation</strong><br>
+<a href="https://kevduc.github.io/diophantine/">kevduc.github.io/diophantine</a></p>
+<p><strong>GitHub</strong><br>
+<a href="https://github.com/kevduc/diophantine">kevduc/diophantine</a></p>
 <h2>Example</h2>
 <h3><code>example.js</code></h3>
 <pre class="prettyprint source lang-js"><code>const { dioSolve, SolutionType } = require('diophantine')
@@ -104,7 +113,7 @@ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.htm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sat Apr 24 2021 05:08:58 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sun Apr 25 2021 10:33:13 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/index.js.html b/docs/index.js.html
@@ -155,7 +155,7 @@ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.htm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sat Apr 24 2021 05:08:58 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sun Apr 25 2021 10:33:13 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "diophantine",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Solve linear diophantine equations",
   "main": "index.js",
   "scripts": {
@@ -13,16 +13,26 @@
     "url": "git+https://github.com/kevduc/diophantine.git"
   },
   "keywords": [
-    "maths",
-    "mathematics",
-    "diophantine",
-    "diophantines",
+    "solver",
     "equation",
+    "mathematics",
+    "linear",
+    "maths",
+    "linear-equations",
     "equations",
+    "equation-solver",
     "solve",
-    "solver",
     "solving",
-    "linear",
+    "linear-equation",
+    "solving-algorithm",
+    "diophantine-solver",
+    "diophantine",
+    "linear-equation-solver",
+    "diophantine-equation",
+    "linear-equations-solution",
+    "equations-solver",
+    "diophantine-equations",
+    "linear-solutions",
     "degree"
   ],
   "author": "kevduc",