-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Alexander Lelidis
committed
Sep 30, 2019
1 parent
2743bea
commit 1d2de50
Showing
1 changed file
with
55 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,55 @@ | ||
# TBD | ||
# mapillary-react | ||
|
||
A simple [mapillaryJs](https://github.com/mapillary/mapillary-js) react component. | ||
|
||
## Table of Contents | ||
|
||
- [Installing](#installing) | ||
- [Examples](#examples) | ||
- [Props](#props) | ||
- [Issues](#issues) | ||
- [Contributing](#contributing) | ||
- [Licensing](#licensing) | ||
|
||
## Installing | ||
|
||
``` | ||
$ npm install --save mapillary-react | ||
``` | ||
|
||
Then, just import to your React component: | ||
|
||
```jsx | ||
import { MapillaryViewer } from 'mapillary-react'; | ||
``` | ||
|
||
## Examples | ||
TBD | ||
|
||
## Props | ||
TBD | ||
|
||
## Issues | ||
|
||
Find a bug or want to request a new feature? Please let us know by submitting an issue. | ||
|
||
## Contributing | ||
|
||
Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](https://github.com/esri/contributing). | ||
|
||
## Licensing | ||
Copyright 2019 Esri | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
|
||
A copy of the license is available in the repository's [license.txt](/license.txt) file. |