[Pkg-javascript-commits] [leaflet-markercluster] 83/128: README improve plugin install instructions

Jonas Smedegaard dr at jones.dk
Sun Apr 16 06:26:06 UTC 2017


This is an automated email from the git hooks/post-receive script.

js pushed a commit to branch master
in repository leaflet-markercluster.

commit 771b41b3e8117b8072c7db7c3254420604a5a68e
Author: ghybs <ghybs at users.noreply.github.com>
Date:   Fri Oct 28 01:46:44 2016 +0400

    README improve plugin install instructions
    
    added local copy (download `v1.0.0` release zip archive from GitHub) and CDN (unpkg) options, besides `npm install`.
    Also detailed where dist files are located, and which ones exactly to use.
---
 README.md | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e2f6e29..c0e9afe 100644
--- a/README.md
+++ b/README.md
@@ -45,7 +45,15 @@ removed link to h1 and indented back 2 spaces all links.
 
 
 ## Using the plugin
-Install with npm: `npm install leaflet.markercluster`
+Include the plugin CSS and JS files on your page after Leaflet files, using your method of choice:
+* [Download the `v1.0.0` release](https://github.com/Leaflet/Leaflet.markercluster/archive/v1.0.0.zip)
+* Use unpkg CDN: `https://unpkg.com/leaflet.markercluster@1.0.0/dist/`
+* Install with npm: `npm install leaflet.markercluster`
+
+In each case, use files in the `dist` folder:
+* `MarkerCluster.css`
+* `MarkerCluster.Default.css` (not needed if you use your own `createIconFunction` instead of the default one)
+* `leaflet.markercluster.js` (or `leaflet.markercluster-src.js` for the non-minified version)
 
 ### Building, testing and linting scripts
 Install jake `npm install -g jake` then run `npm install`

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/leaflet-markercluster.git



More information about the Pkg-javascript-commits mailing list