diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..e69de29 diff --git a/.eslintrc.json b/.eslintrc.json new file mode 100644 index 0000000..7a8cbaf --- /dev/null +++ b/.eslintrc.json @@ -0,0 +1,24 @@ +{ + "env": { + "browser": true, + "commonjs": true, + "es6": true, + "node": true + }, + "extends": "standard", + "parserOptions": { + "sourceType": "module" + }, + "rules": { + "comma-dangle": 0 + }, + "globals": { + "google": true + }, + "plugins": [ + "html" + ], + "settings": { + "html/html-extensions": [".html", ".vue"] + } +} diff --git a/README.md b/README.md new file mode 100644 index 0000000..e83ca96 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# Google maps Components for Vue.js 3 + +Set of mostly used Google Maps components for Vue.js. + +#### Why this library exists? +We heavily use Google Maps in our projects, so I wanted to have a well maintained Google Maps library. + +## Documentation +Checkout https://vue-map.netlify.app for a detailed documentation + +## Installation +You can install it using npm +``` +npm install -S @fawmi/vue-google-maps +``` + +## Basic usage +You need an API Key. Learn how to [get an Api key ](https://developers.google.com/maps/documentation/javascript/get-api-key). + +##Configure Vue to use the Components + +In your `main.js` or inside a Nuxt plugin: + +```js +import { createApp } from 'vue' +import * as VueGoogleMaps from '@fawmi/vue-google-maps' + +const app = createApp(App); +app.use(VueGoogleMaps, { + load: { + key: 'YOUR_API_KEY_COMES_HERE', + }, +}).mount('#app') + +``` +## Use it anywhere in your components + +```vue +