README.md

mapbox-directions.js

This is a Mapbox.js plugin for the Mapbox Directions API. Its main features include:

• Input controls for origin and destination
• Draggable origin and destination markers
• Draggable intermediate waypoints
• Display of turn-by-turn instructions
• Selection of alternate routes

API

Managed as Markdown in API.md, following the standards in DOCUMENTING.md

Building

Requires node.js installed on your system.

git clone https://github.com/mapbox/mapbox-directions.js.git
cd mapbox-directions.js
npm install
make

This project uses browserify to combine dependencies and installs a local copy when you run npm install. make will build the project in dist/.

Tests

Test with phantomjs:

npm test

To test in a browser, run a local development server and go to /test.