[docs] Added README

This commit is contained in:
Ferdinand Thiessen 2021-05-26 17:17:49 +02:00
parent fddbe60b45
commit c41b547e32
2 changed files with 18 additions and 5 deletions

12
README.md Normal file
View File

@ -0,0 +1,12 @@
## 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).

View File

@ -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,