Merge pull request #4 from devforth/add-readme

docs: add readme

Author: ivictbor

README.md

@@ -0,0 +1,7 @@
+# AdminForth OAuth Plugin
+
+<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT" /> <img src="https://woodpecker.devforth.io/api/badges/3848/status.svg" alt="Build Status" /> <a href="https://www.npmjs.com/package/@adminforth/oauth"> <img src="https://img.shields.io/npm/dt/@adminforth/oauth" alt="npm downloads" /></a> <a href="https://www.npmjs.com/package/@adminforth/oauth"><img src="https://img.shields.io/npm/v/@adminforth/oauth" alt="npm version" /></a> <a href="https://www.npmjs.com/package/@adminforth/oauth">
+
+Enables OAuth2-based authentication for an adminforth application.
+
+## For usage, see [AdminForth OAuth Documentation](https://adminforth.dev/docs/tutorial/Plugins/OAuth/)

package.json

@@ -4,6 +4,7 @@
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "homepage": "https://adminforth.dev/docs/tutorial/Plugins/OAuth/",
   "publishConfig": {
     "access": "public"
   },