Jungle-Bus / transport-hours-js

JS library for reading/writing public transport hours information from OpenStreetMap

Transport Hours

Read-me

TransportHours is a JavaScript library for easy reading/writing of public transport hours present in OpenStreetMap. It interprets string values from OSM tags, and also converts your JS objects into string values to go back into OSM.

Install

From NPM

TODO

Using pre-compiled version

Download ready-to-use JS file and example page. You can either include the file in your web page (using <script> markup) or in your NodeJS project.

Usage

For more details about available functions, see API documentation.

Build & develop

For start developing on this library, run the following commands :

git clone https://github.com/Jungle-Bus/transport-hours-js.git
cd transport-hours-js/

npm install

npm run test # Runs unit tests
npm run build # Creates dist/ folder and compiles JS code

More information for developers can be found in develop documentation.

License

Copyright 2019 Jungle Bus & Adrien PAVIE

See LICENSE for complete LGPL3 license.

TransportHoursJS is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

TransportHoursJS is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with TransportHoursJS. If not, see http://www.gnu.org/licenses/.