update readme and docs with links to pages

syonfox · Dec 25, 2022 · 4cdd31c · 4cdd31c
1 parent d69b93e
commit 4cdd31c
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
 
     changelog: 
         add countTokens function
+        add tokenStats function
         updated docs (npm run docs)
 
 
@@ -19,6 +20,9 @@ npm install @syonfox/gpt-3-encoder
 
 
 ## Usage
+<a href="https://github.com/syonfox/GPT-3-Encoder#readme">View on GitHub</a>
+
+<a href="https://syonfox.github.io/GPT-3-Encoder/">View Docs Pages</a>
 
 Compatible with Node >= 12
 

diff --git a/docs/Encoder.js.html b/docs/Encoder.js.html
@@ -327,7 +327,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 4.0.0</a> on Sun Dec 25 2022 12:08:43 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Sun Dec 25 2022 12:15:33 GMT-0500 (Eastern Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/global.html b/docs/global.html
@@ -1022,7 +1022,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 4.0.0</a> on Sun Dec 25 2022 12:08:43 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Sun Dec 25 2022 12:15:33 GMT-0500 (Eastern Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/index.html b/docs/index.html
@@ -46,6 +46,7 @@ <h3> </h3>
         <article><h4>This is a fork of https://github.com/latitudegames/GPT-3-Encoder. I made this fork so I could apply some PRs that had been sent to the upstream repo.</h4>
 <pre><code>changelog: 
     add countTokens function
+    add tokenStats function
     updated docs (npm run docs)
 </code></pre>
 <h1>GPT-3-Encoder</h1>
@@ -56,6 +57,8 @@ <h2>Install with npm</h2>
 <pre class="prettyprint source"><code>npm install @syonfox/gpt-3-encoder
 </code></pre>
 <h2>Usage</h2>
+<p><a href="https://github.com/syonfox/GPT-3-Encoder#readme">View on GitHub</a></p>
+<p><a href="https://syonfox.github.io/GPT-3-Encoder/">View Docs Pages</a></p>
 <p>Compatible with Node &gt;= 12</p>
 <pre class="prettyprint source lang-js"><code>
 import {encode, decode, countTokens, tokenStats} from &quot;gpt-3-encoder&quot;
@@ -125,7 +128,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 4.0.0</a> on Sun Dec 25 2022 12:08:43 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Sun Dec 25 2022 12:15:33 GMT-0500 (Eastern Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>