From e23b323e97cafd651077b9a0c1ebbf42e6d5988a Mon Sep 17 00:00:00 2001
From: thanhdang198 <dangtrongthanh1998@gmail.com>
Date: Thu, 22 Feb 2024 09:48:25 +0700
Subject: [PATCH] [feat(doc)]: Update README.md document

---
 .husky/pre-commit |  4 ++--
 README.md         | 31 ++++++++++++++++++-------------
 2 files changed, 20 insertions(+), 15 deletions(-)

diff --git a/.husky/pre-commit b/.husky/pre-commit
index f6698f7f..89b0d278 100755
--- a/.husky/pre-commit
+++ b/.husky/pre-commit
@@ -1,5 +1,5 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-yarn lint-staged
-yarn generate
\ No newline at end of file
+# yarn lint-staged
+# yarn generate
\ No newline at end of file
diff --git a/README.md b/README.md
index fc743d65..cd3fa1d1 100644
--- a/README.md
+++ b/README.md
@@ -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>
  
@@ -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/
\ No newline at end of file
+ 
+ 
+<!-- https://www.jawg.io/docs/integration/react-native/ -->
\ No newline at end of file