Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexander Lelidis committed Oct 16, 2019
1 parent 553f101 commit 14cdc92
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# react-mapillary

A simple [mapillaryJs](https://github.com/mapillary/mapillary-js) react component. A demo can be found [here](https://alexus37.github.io/react-mapillary/)
A simple [mapillaryJs](https://github.com/mapillary/mapillary-js) react component.

## Table of Contents

Expand Down Expand Up @@ -41,10 +41,19 @@ The simplest way is to include the latest styles from the CDN. A little more inf
```

## Examples
TBD
A demo can be found [here](https://alexus37.github.io/react-mapillary/)

## Props
TBD

| Name | Type | Default | Description |
| :------------ | :------------- | :------ | :---------- |
| clientId* | string | | API key for the streetview. |
| options | object | | Optional configuration object specifing Viewer's and the components' initial setup. |
| onNodeChanged | function | | Fired every time the viewer navigates to a new node. |
| onBearingChanged | function | | Fired when the viewing direction of the camera changes. |
| onTiltChanged | function | | This event is fired when the viewer tilt changes. |
| onFovChanged | function | | This event is fired when the viewer FoV changes. Eg. when the user starts to zoom. |


## Issues

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-mapillary",
"version": "0.0.5",
"version": "0.0.6",
"description": "A react component for the mapillary-js lib",
"main": "dist/react-mapillary.js",
"module": "dist/react-mapillary.js",
Expand Down

0 comments on commit 14cdc92

Please sign in to comment.