npm package: @geoql/v-mapkit.js
Description: MapKit with the power of Vue 3
Author: Vinayak Kulkarni
Latest version: 0.3.0

# V-Mapkit.js 🌎

[![CI](https://img.shields.io/github/workflow/status/geoql/v-mapkit.js/ci?logo=github-actions)](https://github.com/geoql/v-mapkit.js/actions/workflows/ci.yml)
[![CodeQL](https://img.shields.io/github/workflow/status/geoql/v-mapkit.js/codeql?logo=github-actions)](https://github.com/geoql/v-mapkit.js/actions/workflows/codeql.yml)
[![Ship.js Trigger](https://img.shields.io/github/workflow/status/geoql/v-mapkit.js/Ship%20js%20trigger?label=⛴%20Ship.js%20trigger)](https://github.com/geoql/v-mapkit.js/actions/workflows/shipjs-trigger.yml)
[![npm](https://img.shields.io/npm/dm/@geoql/v-mapkit.js?logo=npm)](http://npm-stat.com/charts.html?package=@geoql/v-mapkit.js)
[![npm](https://img.shields.io/npm/v/@geoql/v-mapkit.js/latest?logo=npm)](https://www.npmjs.com/package/@geoql/v-mapkit.js)
[![npm bundle size (version)](https://img.shields.io/bundlephobia/min/@geoql/v-mapkit.js/latest?label=@latest%20size&logo=vue.js)](https://bundlephobia.com/package/@geoql/v-mapkit.js@latest)
[![npm](https://img.shields.io/npm/v/@geoql/v-mapkit.js/legacy?logo=npm)](https://www.npmjs.com/package/@geoql/v-mapkit.js)
[![npm type definitions](https://img.shields.io/npm/types/@geoql/v-mapkit.js)](https://github.com/geoql/v-mapkit.js/blob/master/package.json)
[![DeepScan grade](https://deepscan.io/api/teams/15032/projects/18161/branches/438551/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=15032&pid=18161&bid=438551)
[![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/geoql/v-mapkit.js)](https://snyk.io/test/github/geoql/v-mapkit.js)
[![GitHub contributors](https://img.shields.io/github/contributors/geoql/v-mapkit.js?logo=github)](https://github.com/geoql/v-mapkit.js/graphs/contributors)
[![FOSSA](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fvinayakkulkarni%2F@geoql/v-mapkit.js.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fvinayakkulkarni%2F@geoql/v-mapkit.js?ref=badge_shield)

[![eslint](https://img.shields.io/npm/dependency-version/@geoql/v-mapkit.js/dev/eslint?logo=eslint)](https://eslint.org/)
[![prettier](https://img.shields.io/npm/dependency-version/@geoql/v-mapkit.js/dev/prettier?logo=prettier)](https://prettier.io/)
[![vite](https://img.shields.io/npm/dependency-version/@geoql/v-mapkit.js/dev/vite?logo=vite)](https://vitejs.dev/)
[![vue](https://img.shields.io/npm/dependency-version/@geoql/v-mapkit.js/dev/vue?logo=vue.js)](https://vuejs.org/)
[![typescript](https://img.shields.io/npm/dependency-version/@geoql/v-mapkit.js/dev/typescript?logo=TypeScript)](https://www.typescriptlang.org/)

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

Power of [Vue 3](https://v3.vuejs.org) with awesomeness of [Mapkit](https://developer.apple.com/documentation/mapkitjs)!

## Features

- 💪 Built with [TypeScript](https://www.typescriptlang.org/).
- 🌠 Built with the all new [Vue 3](https://v3.vuejs.org/)

## Table of Contents

- [V-Mapkit.js 🌎](#v-mapkitjs-)
  - [Features](#features)
  - [Table of Contents](#table-of-contents)
    - [Installation](#installation)
    - [Available components](#available-components)
    - [Build Setup](#build-setup)
  - [Built with](#built-with)
  - [Contributing](#contributing)
  - [License](#license)

### Installation

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

### Available components

> Annotations

- [x] [Marker](https://developer.apple.com/documentation/mapkitjs/mapkit/markerannotation)
  - [ ] [Clustering](https://developer.apple.com/documentation/mapkitjs/mapkit/annotations/about_annotation_clustering)
- [x] [Image](https://developer.apple.com/documentation/mapkitjs/mapkit/imageannotation)
  > Overlays
- [x] [Circle](https://developer.apple.com/documentation/mapkitjs/mapkit/circleoverlay)
- [x] [Polygon](https://developer.apple.com/documentation/mapkitjs/mapkit/polygonoverlay)
- [x] [Polyline](https://developer.apple.com/documentation/mapkitjs/mapkit/polylineoverlay)

### Build Setup

```bash
# install dependencies
$ npm install

# start dev
$ npm run dev

# package lib
$ npm run build
```

## Built with

- [TypeScript](https://www.typescriptlang.org/)
- [Vue 3](https://v3.vuejs.org)

## Contributing

1. Fork it ( [https://github.com/geoql/v-mapkit.js/fork](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](https://github.com/geoql/v-mapkit.js/compare)

_Note_:

1. Please contribute using [GitHub Flow](https://web.archive.org/web/20191104103724/https://guides.github.com/introduction/flow/)
2. Commits & PRs will be allowed only if the commit messages & PR titles follow the [conventional commit standard](https://www.conventionalcommits.org/), _read more about it [here](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum)_
3. PS. Ensure your commits are signed. _[Read why](https://withblue.ink/2020/05/17/how-and-why-to-sign-git-commits.html)_

## License

MIT &copy; Vinayak Kulkarni