Skip to content

Commit

Permalink
bumping version, adding note about storybook
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisdrackett committed Jun 8, 2018
1 parent b9bdfe1 commit adc69ae
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 8 deletions.
22 changes: 15 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,30 @@

## Installation

* Running `yarn install` in the component's root directory will install everything you need for development.
- Running `yarn` in the component's root directory will install everything you need for development.

## Demo Development Server

* `npm start` will run a development server with the component's demo app at [http://localhost:3000](http://localhost:3000) with hot module reloading.
- `npm start` will run a development server with the component's demo app at [http://localhost:3000](http://localhost:3000) with hot module reloading.

## Storybook

1. copy `devToken.js.rename` to `devToken.js`
2. add a valid token from apple to `devToken.js`
3. run `yarn storybook`
4. visit the URL storybook gives you
5. play with maps!

## Running Tests

* `npm test` will run the tests once.
- `npm test` will run the tests once.

* `npm run test:coverage` will run the tests and produce a coverage report in `coverage/`.
- `npm run test:coverage` will run the tests and produce a coverage report in `coverage/`.

* `npm run test:watch` will run the tests on every change.
- `npm run test:watch` will run the tests on every change.

## Building

* `npm run build` will build the component for publishing to npm and also bundle the demo app.
- `npm run build` will build the component for publishing to npm and also bundle the demo app.

* `npm run clean` will delete built resources.
- `npm run clean` will delete built resources.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-mapkit",
"version": "0.1.1",
"version": "0.2.0",
"description": "React wrapper for Apple's mapkit.js.",
"license": "MIT",
"main": "lib/index.js",
Expand Down

0 comments on commit adc69ae

Please sign in to comment.