Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
hugobarragon committed Apr 2, 2021
1 parent 308e38b commit 2d2c292
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
| --------- | ------ | ------- |
| `leaflet` | 1.5.1 | ☑ |

!["IMG"](./docs/drift_marker.gif "example")
!["IMG"](./docs/driftmarker.gif "example")

A plugin for leaflet in Typescript to use on react,vue... that allows a marker to move smoothly instead of jump to a new position. Reworked to typescript from [Leaflet.Marker.SlideTo!](https://gitlab.com/IvanSanchez/Leaflet.Marker.SlideTo)

Expand All @@ -23,10 +23,10 @@ A plugin for leaflet in Typescript to use on react,vue... that allows a marker t
npm install --save leaflet-drift-marker
```

`leaflet-drift-marker` requires `leaflet` as [`peerDependency`](https://docs.npmjs.com/files/package.json#peerdependencies)
`leaflet-drift-marker` requires only `leaflet` as [`peerDependency`](https://docs.npmjs.com/files/package.json#peerdependencies)

```bash
npm install --save leaflet react-leaflet
npm install --save leaflet
```

## Usage
Expand All @@ -45,7 +45,7 @@ You can get the build file DriftMarker.js from releases or :
<!-- before the cdn import -->
var exports = {};
</script>
<script src="https://unpkg.com/leaflet-drift-marker@2.0.0/lib/DriftMarker/index.js"></script>
<script src="https://unpkg.com/leaflet-drift-marker@2.0.0/lib/index.js"></script>
```

Still supports all existing leaflet marker properties [check marker](https://leafletjs.com/reference-1.5.0.html#marker)
Expand Down
File renamed without changes
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "leaflet-drift-marker",
"version": "2.0.0-next.0",
"version": "2.0.0",
"private": false,
"description": "Just a marker that can drift its way to a new position, to use with leaflet, and base on Typescript for react,vue...",
"main": "lib/index.js",
Expand All @@ -12,7 +12,6 @@
"keywords": [
"leaflet",
"marker",
"react",
"leaflet marker",
"leaflet-moving-marker",
"leaflet moving marker",
Expand Down

0 comments on commit 2d2c292

Please sign in to comment.