📝 docs(README.md): add links to the source code on GitHub and documen…

…tation to improve accessibility and navigation 📦 chore: add jsdoc.json configuration file for JSDoc documentation generation
skullzarmy · Oct 6, 2023 · a7421e9 · a7421e9
1 parent ab9e8fe
commit a7421e9
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,8 @@
 
 [Mastodon](https://github.com/skullzarmy/Tusk) API Client for node - forked from node-mastodon [abandoned]
 
+[Source on GitHub](https://github.com/skullzarmy/Tusk) | [Documentation](https://skullzarmy.github.io/Tusk/)
+
 ### Notes
 
 -   I forked this project and fixed the obvious issues / updated the packages, and replaced `request` with `axios`.

diff --git a/jsdoc.json b/jsdoc.json
@@ -0,0 +1,3 @@
+{
+    "plugins": ["plugins/markdown", "plugins/summarize"]
+}