Skip to content

Commit 1e73a59

Browse files
author
Jørgen Elgaard Larsen
committed
doc: minor changes
1 parent 59e362b commit 1e73a59

File tree

3 files changed

+36
-3
lines changed

3 files changed

+36
-3
lines changed

.npmignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
assets/
1+
assets/
2+
_config.yml
3+
.npmignore

README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,36 @@ Has only been tested with Leaflet ^1.7.1
5353

5454
```
5555

56+
### Installing the sub-plugin
57+
58+
#### Local copy
59+
60+
1. Download the [`leaflet.layergroup.conditional.js`](https://solfisk.github.io/Leaflet.LayerGroup.Conditional/leaflet.layergroup.conditional.js) file from the latest release.
61+
2. Place the file alongside your page.
62+
3. Add the `script` tag to your page after Leaflet script.
63+
64+
#### CDN
65+
66+
You can alternatively use the free [unpkg](https://unpkg.com) CDN service:
67+
68+
```html
69+
<!-- After Leaflet script -->
70+
<script src="https://unpkg.com/[email protected]/dist/leaflet.layergroup.conditional.js"></script>
71+
```
72+
73+
#### npm
74+
75+
1. Add this package to your project:
76+
77+
```bash
78+
npm install leaflet-layergroup-conditional --save
79+
```
80+
81+
2. Add `script` tag to your page after Leaflet script:
82+
```html
83+
<!-- After Leaflet script -->
84+
<script src="node_modules/leaflet-layergroup-conditional/leaflet.layergroup.conditional.js"></script>
85+
```
5686

5787
## API Reference
5888

@@ -83,4 +113,4 @@ Methods are the same as those of [LayerGroup](http://leafletjs.com/reference.htm
83113

84114
## License
85115

86-
GPL.
116+
[GNU GPLv3](https://www.gnu.org/licenses/gpl-3.0-standalone.html) or later

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@
44
"description": "An extension af Leaflet.LayerGroup with conditional layers.",
55
"keywords": ["leaflet", "layergroup", "conditional"],
66
"repository": "github:Solfisk/Leaflet.LayerGroup.Conditional",
7+
"homepage": "https://solfisk.github.io/Leaflet.LayerGroup.Conditional",
78
"main": "Leaflet.LayerGroup.Conditional.js",
89
"author": "Jørgen Elgaard Larsen <[email protected]>",
910
"license": "GPL-3.0-or-later",
1011
"peerDependencies": {
1112
"leaflet": "^1.0.0"
1213
}
13-
}
14+
}

0 commit comments

Comments
 (0)