Skip to content

Commit

Permalink
Merge pull request #66 from vietmap-company/updateDocument
Browse files Browse the repository at this point in the history
[feat(doc)]: Update README.md document
  • Loading branch information
thanhdt-vietmap authored Feb 22, 2024
2 parents c23411e + e23b323 commit a18e320
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 15 deletions.
4 changes: 2 additions & 2 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

yarn lint-staged
yarn generate
# yarn lint-staged
# yarn generate
31 changes: 18 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,20 @@

_A React Native library for building maps with
the [Vietmap GL Native SDK for iOS & Android](https://bit.ly/vietmap-api)_.

https://www.jawg.io/docs/integration/react-native/add-marker/

Contact [vietmap.vn](https://bit.ly/vietmap-api) to register a valid key.
# Get started

Install package:

Using `npm`:
```bash
npm i @vietmap/vietmap-gl-react-native
```
Using `yarn`:
```bash
yarn add @vietmap/vietmap-gl-react-native
```

<br>

Expand Down Expand Up @@ -52,16 +64,9 @@ the [Vietmap GL Native SDK for iOS & Android](https://bit.ly/vietmap-api)_.

### Misc

- [MapLibreGL](/docs/MapLibreGL.md)
- [Vietmap](/docs/Vietmap.md)
- [CustomHttpHeaders](/docs/CustomHttpHeaders.md)
- [Logger](/docs/Logger.md)

## Contributing / local development

Read the [CONTRIBUTING.md](CONTRIBUTING.md) guide in order to get familiar with how we do things around here and
set up your local dev environment.

## Community

Join the #maplibre-native Slack channel at OSMUS: get an invite at https://slack.openstreetmap.us/
https://www.jawg.io/docs/integration/react-native/


<!-- https://www.jawg.io/docs/integration/react-native/ -->

0 comments on commit a18e320

Please sign in to comment.