docs: clarify documentation is more an API Reference

panva · Apr 8, 2024 · c96c8e0 · c96c8e0
1 parent 5510185
commit c96c8e0
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ The following features are currently in scope and implemented in this software:
 
 `oauth4webapi` has no dependencies and it exports tree-shakeable ESM.
 
-## [Documentation](docs/README.md)
+## [API Reference](docs/README.md)
 
 `oauth4webapi` is distributed via [npmjs.com](https://www.npmjs.com/package/oauth4webapi), [deno.land/x](https://deno.land/x/oauth4webapi), [cdnjs.com](https://cdnjs.com/libraries/oauth4webapi), [jsdelivr.com](https://www.jsdelivr.com/package/npm/oauth4webapi), and [github.com](https://github.com/panva/oauth4webapi).
 

diff --git a/docs/README.md b/docs/README.md
@@ -1,4 +1,4 @@
-# oauth4webapi
+# oauth4webapi API Reference
 
 [💗 Help the project](https://github.com/sponsors/panva)
 

diff --git a/typedoc.json b/typedoc.json
@@ -9,6 +9,7 @@
   "excludeProtected": true,
   "gitRevision": "main",
   "hideGenerator": true,
+  "indexTitle": "oauth4webapi API Reference",
   "out": "docs",
   "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-mdn-links"],
   "readme": "none",