From 618d543dbb580a8029ce6ff4596c5c303a35d8d3 Mon Sep 17 00:00:00 2001
From: Ferdinand Thiessen <rpm@fthiessen.de>
Date: Wed, 26 May 2021 17:17:49 +0200
Subject: [PATCH] [docs] Added README

---
 README.md    | 13 +++++++++++++
 package.json | 11 ++++++-----
 2 files changed, 19 insertions(+), 5 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2211b6e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Flaschengeist types
+
+This package provides the TypeScript typings needed for developing with the [Flaschengeist](https://flaschengeist.dev/Flaschengeist/flaschengeist) and the [Flaschengeist-Plugin](https://flaschengeist.dev/Flaschengeist/flaschengeist-frontend) API.
+
+## License
+
+Licensed under the MIT license, see [LICENSE](./LICENSE) for more details.
+
+## Development
+
+Feel free to report bugs, issues and feature requests using the [Issues function](https://flaschengeist.dev/Flaschengeist/flaschengeist/issues).
+
+Please follow our [general development guide](https://flaschengeist.dev/Flaschengeist/flaschengeist/wiki/Development#general-development).
diff --git a/package.json b/package.json
index 92734b3..eedaa71 100644
--- a/package.json
+++ b/package.json
@@ -1,17 +1,16 @@
 {
-  "private": true,
   "license": "MIT",
   "version": "1.0.0-alpha.1",
   "name": "@flaschengeist/types",
-  "author": "Ferdinand <rpm@fthiessen.de>",
-  "homepage": "https://flaschengeist.dev/Flaschengeist",
+  "author": "Ferdinand Thiessen <rpm@fthiessen.de>",
+  "homepage": "https://flaschengeist.dev/",
   "description": "Flaschengeist TypeScript typings",
   "bugs": {
     "url": "https://flaschengeist.dev/Flaschengeist/flaschengeist/issues"
   },
   "repository": {
     "type": "git",
-    "url": "https://flaschengeist.dev/Flaschengeist/flaschengeist-typings"
+    "url": "https://flaschengeist.dev/Flaschengeist/flaschengeist-types"
   },
   "typings": "types/index.d.ts",
   "scripts": {
@@ -20,7 +19,9 @@
   },
   "devDependencies": {
     "prettier": "^2.3.0",
-    "typescript": "^4.2.4"
+    "typescript": "^4.2.4",
+    "vue": "^3.0.11",
+    "vue-router": "^4.0.8"
   },
   "prettier": {
     "singleQuote": true,