README.md

V-Mapkit.js 🌎

⚠️ Note ⚠️ This project is still under heavy development and is missing features. Contributions are welcome!

Power of Vue 3 with awesomeness of Mapkit!

Features

• 💪 Built with TypeScript.
• 🌠 Built with the all new Vue 3

Table of Contents

• V-Mapkit.js 🌎
  • Features
  • Table of Contents
    • Installation
    • Available components
    • Build Setup
  • Built with
  • Contributing
  • License

Installation

npm install @geoql/v-mapkit.js
npm install @vueuse/core

Available components

Annotations

• Marker
  • Clustering
• Image

  Overlays

• Circle
• Polygon
• Polyline

Build Setup

# install dependencies
$ npm install

# start dev
$ npm run dev

# package lib
$ npm run build

Built with

• TypeScript
• Vue 3

Contributing

1. Fork it ( https://github.com/geoql/v-mapkit.js/fork )
2. Create your feature branch (git checkout -b feat/new-feature)
3. Commit your changes (git commit -Sam 'feat: add feature')
4. Push to the branch (git push origin feat/new-feature)
5. Create a new Pull Request

Note:

1. Please contribute using GitHub Flow
2. Commits & PRs will be allowed only if the commit messages & PR titles follow the conventional commit standard, read more about it here
3. PS. Ensure your commits are signed. Read why

License

MIT © Vinayak Kulkarni