Commit 5cb3187e authored by Fawad Mirzad's avatar Fawad Mirzad
Browse files

Update docs

parent cc9c3085

docs/src/.vuepress/config.js

+3 −3
Original line number Diff line number Diff line
@@ -43,13 +43,13 @@ module.exports = { 
      }

    ],

    sidebar: {

      '/guide/': [

      '/docs/': [

        {

          title: 'Guide',

          title: 'Getting started',

          collapsable: false,

          children: [

            '',

            'using-vue',

            'getting-started',

          ]

        }

      ],

docs/src/config/README.md

deleted100755 → 0
+0 −15
Original line number Diff line number Diff line 
---

sidebar: auto

---



# Config



## foo



- Type: `string`

- Default: `/`



## bar



- Type: `string`

- Default: `/`

docs/src/docs/README.md

0 → 100644
+10 −0
Original line number Diff line number Diff line 
# Introduction



`@fawmi/vue-google-maps` provides a set of Vue.js 3 components wrapping the Google Maps API v3.



Currently `Map`, `Marker`, `InfoWindow`,  `Polygon` and `Rectangle` are supported.



Other components are still under development. 





Checkout getting started to read, how to install and use vue-google-maps
 
 No newline at end of file

docs/src/docs/getting-started.md

0 → 100755
+31 −0
Original line number Diff line number Diff line 
# Install and configure



## Install



to install it via NPM 

```bash

npm install -S @fawmi/vue-google-maps

```

You can also install via Yarn

```bash

yarn add @fawmi/vue-google-maps

```



## Example

Here is a basic example 



```javascript

import { createApp } from 'vue'

import googleMap from '@fawmi/vue-google-maps'

import App from './App.vue';



const googleMapOption = {

    apiKey: 'here_comes_your_api_key',

}



const app = createApp(App);



app.use(googleMap, googleMapOption)

app.mount('#app')



```

docs/src/docs/introduction.md

0 → 100755
+10 −0
Original line number Diff line number Diff line 
# Introduction



`@fawmi/vue-google-maps` provides a set of Vue.js 3 components wrapping the Google Maps API v3.



Currently `Map`, `Marker`, `InfoWindow`,  `Polygon` and `Rectangle` are supported.



Other components are still under development. 





Checkout getting started to read, how to install and use vue-google-maps
 
 No newline at end of file