diff --git a/.changeset/wacky-experts-lose.md b/.changeset/wacky-experts-lose.md new file mode 100644 index 0000000..c651604 --- /dev/null +++ b/.changeset/wacky-experts-lose.md @@ -0,0 +1,5 @@ +--- +'@react-native-motion-kit/swipe-deck': patch +--- + +Update the English and Korean READMEs with the React Native Motion Kit logo and remove internal API direction notes from the public docs. diff --git a/README.ko.md b/README.ko.md index 3139c61..aefd39d 100644 --- a/README.ko.md +++ b/README.ko.md @@ -2,6 +2,10 @@ [English](README.md) +
+ React Native Motion Kit logo +
+ Reanimated와 Gesture Handler 기반의 고성능 React Native용 Tinder 스타일 swipe deck / swipe card 라이브러리입니다. ## 특징 @@ -656,25 +660,6 @@ function DeepStackDeck() { | 남은 데이터가 10개이고 `visibleCardCount={20}` | 최대 남은 10개 | | 짝수 값 | 최대 예산으로 그대로 유지되며, 홀수로 올림 처리하지 않음 | -## API 방향 - -현재 public API에는 factory scope deck hook과 `id` 기반 deck registration이 포함되어 있습니다. - -- `createSwipeDeck()`는 typed factory namespace를 만듭니다. -- `Root`와 `Card`는 deck을 렌더링합니다. -- `useDeckState(id?)`, `useDeckActions(id?)`, `useDeckInteraction(id?)`, `useDeckEvent(eventName, initialValue?, id?)`, `useDeckEventListener(eventName, listener, id?)`는 해당 factory namespace에서 deck 전체 state, action, Reanimated interaction 값, commit된 model event를 제공합니다. -- `SwipeDeckUndoMotion`과 `actions.undo()`는 preset 기반 undo/back-swipe 동작을 제공합니다. -- `id`는 같은 factory 안에서 여러 Root를 mount할 때 어떤 deck을 바라볼지 선택합니다. - -앞으로의 API 방향에는 다음이 포함될 수 있습니다. - -- public `Provider` 또는 custom registry boundary -- 외부 swipe control을 위한 trigger component -- 더 명시적인 prerender/window control -- 성능을 해치지 않으면서 DX를 개선할 수 있는 lower-level controller API - -현재 shipped surface는 public Provider나 trigger component를 의도적으로 포함하지 않습니다. Factory scope hook으로 주요 외부 UI 사용 사례를 처리하면서 core deck은 작게 유지합니다. - ## 기여하기 - [Development workflow](CONTRIBUTING.md#development-workflow) diff --git a/README.md b/README.md index 486d81a..b279711 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ [한국어](README.ko.md) +
+ React Native Motion Kit logo +
+ High-performance Tinder-style swipe deck and swipe cards for React Native, powered by Reanimated and Gesture Handler. ## Highlights @@ -662,25 +666,6 @@ function DeepStackDeck() { | `visibleCardCount={20}` with 10 remaining items | At most those 10 remaining items. | | even values | Kept as the maximum budget; not rounded up. | -## API direction - -The current public API already includes factory-scoped deck hooks and `id`-based deck registration: - -- `createSwipeDeck()` creates a typed factory namespace. -- `Root` and `Card` render the deck. -- `useDeckState(id?)`, `useDeckActions(id?)`, `useDeckInteraction(id?)`, `useDeckEvent(eventName, initialValue?, id?)`, and `useDeckEventListener(eventName, listener, id?)` expose deck-wide state, actions, Reanimated interaction values, and committed model events from that factory namespace. -- `SwipeDeckUndoMotion` and `actions.undo()` provide preset-based undo/back-swipe behavior. -- `id` selects a deck inside the same factory when multiple roots are mounted. - -Future API directions may include: - -- public `Provider` or custom registry boundary; -- trigger components for external swipe controls; -- more explicit prerender/window controls; -- lower-level controller APIs when they improve DX without hurting performance. - -The current shipped surface intentionally avoids a public Provider or trigger component for now. Factory-scoped hooks cover the main external UI use cases while keeping the core deck small. - ## Contributing - [Development workflow](CONTRIBUTING.md#development-workflow) diff --git a/assets/logo.png b/assets/logo.png new file mode 100644 index 0000000..b69e1e3 Binary files /dev/null and b/assets/logo.png differ