Add Readme, enhance package.json

0815pascal · 0815pascal · commit 4ff951941f6b · 2023-12-27T18:17:36.000+01:00
diff --git a/README.md b/README.md
@@ -0,0 +1,3 @@
+# Honkit API Documentation Plugin
+
+Hello World!
diff --git a/package.json b/package.json
@@ -1,19 +1,30 @@
 {
   "name": "honkit-plugin-api-documentation",
+  "repository": {
+  "type": "git",
+  "url": "https://github.com/0815pascal/honkit-plugin-api-documentation"
+},
   "version": "0.0.1",
-  "description": "A Honkit plugin to dynamically generate templates using Handlebars",
+  "main": "index.js",
+  "description": "A Honkit plugin to dynamically generate an API documentation using Handlebars",
   "keywords": [
     "honkit",
     "gitbook",
     "plugin",
     "dynamic",
-    "template"
+    "template",
+    "api",
+    "swagger",
+    "openApi"
   ],
   "author": "Pascal Witzig",
   "license": "MIT",
   "dependencies": {
     "handlebars": "^4.7.8"
   },
+  "peerDependencies": {
+  "honkit": ">=3.0.0"
+},
   "engines": {
     "node": ">=18.0.0",
     "gitbook": ">=3.0.0"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Honkit API Documentation Plugin`
	`2`	`+`
	`3`	`+Hello World!`