Skip to content

Commit 8058262

Browse files
author
David Emory
committed
fix(build): Update docs for new 0.1.x release
1 parent c7374ba commit 8058262

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

Diff for: README.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
11
# otp-react-redux
22

3-
<img src="otprr.png" width="500" />
3+
<img src="https://github.com/opentripplanner/otp-react-redux/raw/master/otprr.png" width="500" />
44

55
A library for writing modern [OpenTripPlanner](http://www.opentripplanner.org/)-compatible multimodal journey planning applications using [React]() and [Redux]().
66

7-
*NOTE: OTP-RR is in the very early stages of development and current functionality is extremely limited. An 0.1 version with basic support for itinerary-based planning is targeted for late February / early March 2017.*
8-
97
## Running the Example
108

119
A simple example of an OTP-RR application is included in the repository.
1210

1311
To run, first clone the repo and install [yarn](https://yarnpkg.com/) if needed.
1412

15-
You may want to update `example-config.yml` with the API endpoint and initial map origin. The default values are for a Conveyal test server for Portland, OR.
13+
Copy `example-config.yml` to `config.yml`. Update `config.yml` with your Mapzen API key, and optionally, the OTP endpoint and initial map origin. (The default values are for a Conveyal test server for Portland, OR.)
1614

1715
Install the dependencies and start a test instance using yarn:
1816

0 commit comments

Comments
 (0)