Skip to content

Commit

Permalink
prepping for github
Browse files Browse the repository at this point in the history
  • Loading branch information
iboates committed Apr 7, 2019
1 parent 38e2e21 commit 0d57b02
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# leaflet-spotlight

A Leaflet plugin for creating a "highlight" effect on features near the user's cursor.

## Dependencies

* `Leaflet >= 1.1.0`
* `turf.js >= 5.1.6`

## Installation

Import the library into your HTML document. Make sure that it is imported AFTER Leaflet and turf.js

```
<script src="src/leaflet-spotlight-extension.min.js"></script>
```

## Examples

Detailed examples for various use cases can be found in the
[examples](https://github.com/iboates/leaflet-spotlight/tree/master/examples) folder.

<script src="https://gist.github.com/iboates/88edf2d2f58a4c130868e9936632ce63.js"></script>
1 change: 1 addition & 0 deletions src/leaflet-spotlight-extension.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 0d57b02

Please sign in to comment.