Add readme file

This commit is contained in:
Fawad Mirzad
2020-10-16 16:54:36 +02:00
parent 8e0792b9d9
commit 964a451936
3 changed files with 25 additions and 2 deletions

2
package-lock.json generated
View File

@@ -1,5 +1,5 @@
{ {
"name": "@fawmi/vue-google-maps", "name": "@fawmi/vue-google-maps",
"version": "0.0.34", "version": "0.1.0",
"lockfileVersion": 1 "lockfileVersion": 1
} }

View File

@@ -1,7 +1,7 @@
{ {
"name": "@fawmi/vue-google-maps", "name": "@fawmi/vue-google-maps",
"description": "Google Map components for Vue.js 3", "description": "Google Map components for Vue.js 3",
"version": "0.0.34", "version": "0.1.0",
"private": false, "private": false,
"main": "index.js", "main": "index.js",
"scripts": { "scripts": {

View File

@@ -0,0 +1,23 @@
# Vue.js google maps
vue.js 3 components for Google maps
## Still in development
This repo is still in active development. Most of the components are already implemeted, but some important parts are still missing. Documentations are missing too.
## Install
to install it via NPM
```
npm install -S @fawmi/vue-google-maps
```
You can also install via Yarn
```
yarn add @fawmi/vue-google-maps
```
## Documentation
A detailed documentation with examples can be found at https://vue-map.netlify.app/