Merge pull request #6 from devforth/add-readme

docs: add README

Author: ivictbor

README.md

@@ -0,0 +1,7 @@
+# AdminForth ForeignInlineList 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/foreign-inline-list"> <img src="https://img.shields.io/npm/dt/@adminforth/foreign-inline-list" alt="npm downloads" /></a> <a href="https://www.npmjs.com/package/@adminforth/foreign-inline-list"><img src="https://img.shields.io/npm/v/@adminforth/foreign-inline-list" alt="npm version" /></a> <a href="https://www.npmjs.com/package/@adminforth/foreign-inline-list">
+
+Allows to add an inline list of connected foreign resource records on a adminforth show page.
+
+## For usage, see [AdminForth ForeignInlineList Documentation](https://adminforth.dev/docs/tutorial/Plugins/ForeignInlineList/)

package.json

@@ -5,6 +5,7 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
+  "homepage": "https://adminforth.dev/docs/tutorial/Plugins/ForeignInlineList/",
   "scripts": {
     "build": "tsc && rsync -av --exclude 'node_modules' custom dist/",
     "prepare": "npm link adminforth"