v-spotlight/README.md

Tiny reusable Spotlight component for your Vue App

# V-Spotlight

[![NPM version](https://img.shields.io/npm/v/v-spotlight.svg?style=flat)](https://npmjs.com/package/v-spotlight) [![NPM downloads](https://img.shields.io/npm/dm/v-spotlight.svg?style=flat)](https://npmjs.com/package/v-spotlight) [![CircleCI](https://travis-ci.org/vinayakkulkarni/v-spotlight.svg?branch=master)](https://travis-ci.org/vinayakkulkarni/v-spotlight)

* 🔦 Tiny reusable Spotlight component for your Vue App

- Demo Link - [Click Here](http://bit.ly/v-spotlight)

- This is [on GitHub](https://github.com/vinayakkulkarni/v-spotlight) so let me know if I've b0rked it somewhere, give me a star :star: if you like it :beers:

## Install

```bash
yarn add v-spotlight
```

CDN: [UNPKG](https://unpkg.com/v-spotlight/dist/) | [jsDelivr](https://cdn.jsdelivr.net/npm/v-spotlight/dist/)

## Usage

```vue
<template>
  <v-spotlight background="'https://placehold.it/1000x1000'"></v-spotlight>
</template>

<script>
import VSpotlight from 'v-spotlight';

export default {
  components: {
    VSpotlight,
  },
};
</script>
```

## API

### Props

* `background`: Add background image for the spotlight
* `position`: Background image cover position

## Contributing

1.  Fork it!
2.  Create your feature branch: `git checkout -b my-new-feature`
3.  Commit your changes: `git commit -am 'Add some feature'`
4.  Push to the branch: `git push origin my-new-feature`
5.  Submit a pull request :D

## Author

**v-spotlight** © [Vinayak](https://github.com/vinayakkulkarni), Released under the [MIT](./LICENSE) License.<br>
Authored and maintained by Vinayak Kulkarni with help from contributors ([list](https://github.com/vinayakkulkarni/v-spotlight/contributors)).

> [vinayakkulkarni.dev](https://vinayakkulkarni.dev) · GitHub [@vinayakkulkarni](https://github.com/vinayakkulkarni) · Twitter [@\_vinayak_k](https://twitter.com/_vinayak_k)