Skip to content

Commit

Permalink
docs(readme): improve readme
Browse files Browse the repository at this point in the history
BREAKING CHANGE:

- Refactor various components and example.js file to more heavily use React's context API (see #274)
- Update to use latest config schema compatible with opentripplanner/core-utils v3 (see #201)
  • Loading branch information
evansiroky committed Jan 5, 2021
1 parent 310f5db commit 7399e23
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,20 @@ A library for writing modern [OpenTripPlanner](http://www.opentripplanner.org/)-

## Running the Example

A simple example of an OTP-RR application is included in the repository.
An example of an OTP-RR application is included in the repository. The example project is a single page application with a root entry point of the `example.js` file. This example.js file can be modified to suit the needs of a particular implementation.

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

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.)
Copy `example-config.yml` to `config.yml`. Update `config.yml` with the needed API keys, and optionally, the OTP endpoint and initial map origin. (The default values are for a test server for Portland, OR.).

Install the dependencies and start a test instance using yarn:
Install the dependencies and start a local instance using the following script:

```bash
yarn install
yarn start
```

## Library Documentation

Coming Soon
More coming soon...

As of version 2.0, otp-react-redux utilizes React's context API in a number of components. This changed the way that some components receive props such that they will not work properly unless wrapped with the context provider used in the `ResponsiveWebapp` component.

0 comments on commit 7399e23

Please sign in to comment.