@raruto/leaflet-elevation 2.0.8 → 2.2.0

package/README.md

@@ -23,9 +23,10 @@ _For a working example see one of the following demos:_
 - [loading individual .gpx tracks](https://raruto.github.io/leaflet-elevation/examples/leaflet-elevation_toggable-tracks.html)
 - [loading multiple .gpx tracks (hover to toggle)](https://raruto.github.io/leaflet-elevation/examples/leaflet-elevation_hoverable-tracks.html)
 - [loading multiple .gpx tracks (click to toggle)](https://raruto.github.io/leaflet-elevation/examples/leaflet-elevation_toggable-charts.html)
+- [loading multiple maps](https://raruto.github.io/leaflet-elevation/examples/leaflet-elevation_multiple-maps.html)
 - [translating plugin labels](https://raruto.github.io/leaflet-elevation/examples/leaflet-elevation_i18n-strings.html)
 - [using custom colors](https://raruto.github.io/leaflet-elevation/examples/leaflet-elevation_custom-theme.html)
-- [using .gpx extensions (cadence + heart)](https://raruto.github.io/leaflet-elevation/examples/leaflet-elevation_extended-ui.html)
+- [using .gpx extensions (cadence, heart, pace)](https://raruto.github.io/leaflet-elevation/examples/leaflet-elevation_extended-ui.html)
 - [using .gpx waypoint icons](https://raruto.github.io/leaflet-elevation/examples/leaflet-elevation_gpx-waypoints.html)
 - [using .geojson waypoint icons](https://raruto.github.io/leaflet-elevation/examples/leaflet-elevation_geojson-waypoints.html)
 
@@ -62,7 +63,7 @@ _For a working example see one of the following demos:_
 
     <!-- leaflet-ui -->
     <script src="https://unpkg.com/leaflet@1.7.1/dist/leaflet.js"></script>
-    <script src="https://unpkg.com/leaflet-ui@0.5.1/dist/leaflet-ui.js"></script>
+    <script src="https://unpkg.com/leaflet-ui@0.5.4/dist/leaflet-ui.js"></script>
 
     <!-- leaflet-elevation -->
     <link rel="stylesheet" href="https://unpkg.com/@raruto/leaflet-elevation/dist/leaflet-elevation.css" />
@@ -123,15 +124,15 @@ _For a working example see one of the following demos:_
         // Speed chart profile: true || "summary" || "disabled" || false
         speed: false,
 
+        // Altitude chart profile: true || "summary" || "disabled" || false
+        altitude: true,
+
         // Display time info: true || "summary" || false
-        time: false,
+        time: true,
 
-        // Display distance info: true || "summary"
+        // Display distance info: true || "summary" || false
         distance: true,
 
-        // Display altitude info: true || "summary"
-        altitude: true,
-
         // Summary track info style: "inline" || "multiline" || false
         summary: 'multiline',
 
@@ -186,6 +187,22 @@ _For a working example see one of the following demos:_
     </script>
     ```
 
+### Build Guide
+
+For those wishing to try cloning this repository into a local development folder (eg. /var/www):
+
+```shell
+git clone git@github.com:Raruto/leaflet-elevation.git
+cd ./leaflet-elevation
+
+npm i         # install dependencies
+npm run dev   # auto-generate "dist" files
+npm run build # generate "dist" files (once)
+npm run test  # test "spec" files (once)
+```
+
+After that you can start developing inside the `src` and `test` folders (eg. open "http://localhost/leaflet-elevation/test" in your browser to preview changes). Check also [CONTRIBUTING.md](.github/CONTRIBUTING.md) file for some information about it.
+
 ### FAQ
 
 <details>
@@ -247,6 +264,10 @@ var map = L.map('map', {
 
 _Related: [Leaflet-UI presets](https://github.com/raruto/leaflet-ui), [QGIS Integration](https://github.com/faunalia/trackprofile2web)_
 
+### Changelog
+
+All notable changes to this project are documented in the [releases](https://github.com/Raruto/leaflet-elevation/releases) page.
+
 ---
 
 **Compatibile with:**
@@ -261,4 +282,4 @@ _Related: [Leaflet-UI presets](https://github.com/raruto/leaflet-ui), [QGIS Inte
 
 ---
 
-Check out [CONTRIBUTING.md](.github/CONTRIBUTING.md) file for more information on supporting the development of this library.
+**License:** GPL-3.0+