Skip to content

Commit 91d20d0

Browse files
docs: document @couchbase/couchbase-lite-react-native npm package
Add npm registry links, migration guidance for the legacy cbl-reactnative package, release notes, and official repository metadata.
1 parent bcd89e0 commit 91d20d0

7 files changed

Lines changed: 44 additions & 2 deletions

File tree

docs/Guides/Migration/v1.1.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,25 @@ Version 1.1 is focused on React Native New Architecture support and better troub
1616
2. **Improved file logging** - React Native wrapper diagnostics can be written to file and custom log sinks.
1717
3. **LogSinks.write()** - application code can write messages into configured Couchbase Lite log sinks.
1818
4. **Reliability fixes** - listener cleanup, document expiration, and conflict-aware deletes are improved.
19+
5. **Official npm package** - published as `@couchbase/couchbase-lite-react-native`, replacing the legacy `cbl-reactnative` package.
20+
21+
## NPM Package Rename
22+
23+
Version 1.1 is published on npm as [`@couchbase/couchbase-lite-react-native`](https://www.npmjs.com/package/@couchbase/couchbase-lite-react-native). The legacy unscoped package `cbl-reactnative` (1.0.1 and earlier) is superseded. New installs and upgrades should use the scoped package.
24+
25+
| What to update | Before (`cbl-reactnative`) | After (`@couchbase/couchbase-lite-react-native`) |
26+
|---|---|---|
27+
| Install | `npm install cbl-reactnative` | `npm install @couchbase/couchbase-lite-react-native` |
28+
| TypeScript imports | `from 'cbl-reactnative'` | `from '@couchbase/couchbase-lite-react-native'` |
29+
| Android Gradle path | `node_modules/cbl-reactnative/android/build.gradle` | `node_modules/@couchbase/couchbase-lite-react-native/android/build.gradle` |
30+
| Expo plugin podspec path | `node_modules/cbl-reactnative/cbl-reactnative.podspec` | `node_modules/@couchbase/couchbase-lite-react-native/cbl-reactnative.podspec` |
31+
32+
**Upgrade checklist:**
33+
34+
1. Remove `cbl-reactnative` from `package.json`
35+
2. Install `@couchbase/couchbase-lite-react-native`
36+
3. Update all import paths and native wiring paths
37+
4. Rebuild native projects (`pod install`, Gradle clean build)
1938

2039
## TurboModule Support
2140

@@ -73,5 +92,6 @@ await LogSinks.write(
7392

7493
## Repository Links
7594

95+
- [@couchbase/couchbase-lite-react-native on npm](https://www.npmjs.com/package/@couchbase/couchbase-lite-react-native)
7696
- [couchbase/couchbase-lite-react-native](https://github.com/couchbase/couchbase-lite-react-native)
7797
- [couchbase/couchbase-lite-js-common](https://github.com/couchbase/couchbase-lite-js-common)

docs/ProductNotes/release-notes.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Improvements and Fixes:
2323
- Android replicator filters can use JavaScript arrow functions in the V8 evaluation path.
2424

2525
Repository Updates:
26+
- Official npm package: [@couchbase/couchbase-lite-react-native](https://www.npmjs.com/package/@couchbase/couchbase-lite-react-native)
27+
- The legacy `cbl-reactnative` package is superseded; new installs and upgrades should use the scoped package
2628
- Main React Native repository: [couchbase/couchbase-lite-react-native](https://github.com/couchbase/couchbase-lite-react-native)
2729
- Shared JavaScript library repository: [couchbase/couchbase-lite-js-common](https://github.com/couchbase/couchbase-lite-js-common)
2830

docs/StartHere/install.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,18 @@ The installation for the Native Module is provided in two sections: one section
2222

2323
### React Native Based Apps
2424

25-
To use the Couchbase Lite React Native Native Module in a standard React Native app, you will need to install the npm package. From the root of your applications project directory (the directory containing your `package.json` file), run the following command:
25+
To use the Couchbase Lite React Native Native Module in a standard React Native app, you will need to install the npm package [@couchbase/couchbase-lite-react-native](https://www.npmjs.com/package/@couchbase/couchbase-lite-react-native). From the root of your applications project directory (the directory containing your `package.json` file), run one of the following commands:
2626

2727
```bash
2828
npm install @couchbase/couchbase-lite-react-native
29+
# or
30+
yarn add @couchbase/couchbase-lite-react-native
2931
```
3032

33+
:::note
34+
New projects should install the scoped package above. Upgrading from the legacy `cbl-reactnative` package (1.0.1 and earlier)? See the [Version 1.1 Migration Guide](../Guides/Migration/v1.1.md#npm-package-rename).
35+
:::
36+
3137
Once installed, you will want to build each native project (iOS and Android) to link the native module to your project.
3238

3339
#### iOS

docs/StartHere/prerequisties.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar_position: 1
77

88
Couchbase Lite for React Native is provided as a [Native Module](https://reactnative.dev/docs/legacy/native-modules-intro). Version 1.1 supports [React Native New Architecture](https://reactnative.dev/architecture/overview) through TurboModules on iOS and Android.
99

10-
The Native Module can be found at the following repository: [Couchbase Lite for React Native](https://github.com/couchbase/couchbase-lite-react-native). Shared TypeScript and JavaScript code lives in [cblite-js](https://github.com/couchbase/couchbase-lite-js-common).
10+
The Native Module can be found at the following repository: [Couchbase Lite for React Native](https://github.com/couchbase/couchbase-lite-react-native). npm package: [@couchbase/couchbase-lite-react-native](https://www.npmjs.com/package/@couchbase/couchbase-lite-react-native). Shared TypeScript and JavaScript code lives in [cblite-js](https://github.com/couchbase/couchbase-lite-js-common).
1111

1212
A developer using this plugin should have a basic understanding of the following technologies:
1313
- [React Native](https://reactnative.dev/)

docs/intro.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ More information on React Native - Native Modules can be found here: [React Nati
2222
Couchbase Lite for React Native has officially graduated from a community project to a fully Enterprise-Supported offering
2323
:::
2424

25+
Install via npm: [@couchbase/couchbase-lite-react-native](https://www.npmjs.com/package/@couchbase/couchbase-lite-react-native) — see [Install](StartHere/install.md) for full setup.
26+
2527
The version of this Native Module is based on supporting Couchbase Lite Enterprise for iOS and Android. A [license](https://www.couchbase.com/pricing/) is required to use Couchbase Lite Enterprise edition.
2628

2729
## Features

docusaurus.config.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,10 @@ const config = {
187187
label: 'GitHub',
188188
href: 'https://github.com/couchbase/couchbase-lite-react-native',
189189
},
190+
{
191+
label: 'npm',
192+
href: 'https://www.npmjs.com/package/@couchbase/couchbase-lite-react-native',
193+
},
190194
],
191195
},
192196
],

package.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22
"name": "cbl-reactnative",
33
"version": "1.0.1",
44
"private": true,
5+
"repository": {
6+
"type": "git",
7+
"url": "git+https://github.com/couchbase/cbl-reactnative-docs.git"
8+
},
9+
"homepage": "https://cbl-reactnative.dev/",
10+
"bugs": {
11+
"url": "https://github.com/couchbase/cbl-reactnative-docs/issues"
12+
},
513
"scripts": {
614
"docusaurus": "docusaurus",
715
"start": "docusaurus start",

0 commit comments

Comments
 (0)