Skip to content

Commit

Permalink
doc: minor changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Jørgen Elgaard Larsen committed Apr 7, 2021
1 parent 59e362b commit 1e73a59
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 3 deletions.
4 changes: 3 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
assets/
assets/
_config.yml
.npmignore
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,36 @@ Has only been tested with Leaflet ^1.7.1

```

### Installing the sub-plugin

#### Local copy

1. Download the [`leaflet.layergroup.conditional.js`](https://solfisk.github.io/Leaflet.LayerGroup.Conditional/leaflet.layergroup.conditional.js) file from the latest release.
2. Place the file alongside your page.
3. Add the `script` tag to your page after Leaflet script.

#### CDN

You can alternatively use the free [unpkg](https://unpkg.com) CDN service:

```html
<!-- After Leaflet script -->
<script src="https://unpkg.com/[email protected]/dist/leaflet.layergroup.conditional.js"></script>
```

#### npm

1. Add this package to your project:

```bash
npm install leaflet-layergroup-conditional --save
```

2. Add `script` tag to your page after Leaflet script:
```html
<!-- After Leaflet script -->
<script src="node_modules/leaflet-layergroup-conditional/leaflet.layergroup.conditional.js"></script>
```

## API Reference

Expand Down Expand Up @@ -83,4 +113,4 @@ Methods are the same as those of [LayerGroup](http://leafletjs.com/reference.htm
## License
GPL.
[GNU GPLv3](https://www.gnu.org/licenses/gpl-3.0-standalone.html) or later
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
"description": "An extension af Leaflet.LayerGroup with conditional layers.",
"keywords": ["leaflet", "layergroup", "conditional"],
"repository": "github:Solfisk/Leaflet.LayerGroup.Conditional",
"homepage": "https://solfisk.github.io/Leaflet.LayerGroup.Conditional",
"main": "Leaflet.LayerGroup.Conditional.js",
"author": "Jørgen Elgaard Larsen <[email protected]>",
"license": "GPL-3.0-or-later",
"peerDependencies": {
"leaflet": "^1.0.0"
}
}
}

0 comments on commit 1e73a59

Please sign in to comment.