Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mym0404 committed Apr 1, 2024
1 parent 5d58f01 commit 035981a
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 17 deletions.
37 changes: 21 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,36 @@
# @mj-studio/react-native-naver-map
- [English Documentation(WIP)](/doc/en.md)

Naver Map Component for React Native
---

## Installation
리액트 네이티브 [Naver Map](https://www.ncloud.com/product/applicationService/maps) 컴포넌트입니다.

```sh
npm install @mj-studio/react-native-naver-map
```
이 프로젝트는 다음과 같은 목적을 가집니다.

1. 더 이상 관리되지 않는 기존 라이브러리 대체
2. New Architecture Renderer Fabric 지원

## Usage
>[!NOTE]
>Fabric을 지원한다고 Old Architecture를 지원하지 않는 것이 아닌 두 Architecture모두에서 작동하는 컴포넌트를 제작합니다.
```js
import { NaverMapView } from "@mj-studio/react-native-naver-map";
## Supporting Table

// ...
| | iOS | Android | Web |
|--------|------------------------|------------------------|------------|
| Bridge | Working In Progress ⚒️ | Working In Progress ⚒️ | Planned 📦 |
| Fabric | Planned 📦 | Planned 📦 | Planned 📦 |

<NaverMapView color="tomato" />

## Installation

```sh
npm install @mj-studio/react-native-naver-map
```


## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

## License

MIT

---

Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)
MIT
Empty file added doc/en.md
Empty file.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@
"clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
"prepare": "husky",
"release": "release-it",
"gen:ios:fabric": "node example/node_modules/react-native/scripts/generate-codegen-artifacts.js --path example/ --outputPath RCTNaverMapViewViewProtocol/generated/"
"codegen:android": "cd example/android && ./gradlew generateCodegenArtifactsFromSchema",
"codegen:ios": "node example/node_modules/react-native/scripts/generate-codegen-artifacts.js --path example/ --outputPath RCTNaverMapViewViewProtocol/generated/"
},
"keywords": [
"react-native",
Expand Down

0 comments on commit 035981a

Please sign in to comment.