Skip to content

Commit b3615fe

Browse files
committed
updated readme file and expo-example
1 parent f1d5244 commit b3615fe

23 files changed

+157278
-73
lines changed

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "src/cblite-js"]
2+
path = src/cblite-js
3+
url = [email protected]:Couchbase-Ecosystem/cblite-js.git

CONTRIBUTING.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
[!CAUTION]
2+
This document was pre-generated and isn't up-to-date - but will be updated shortly. What I'm saying is following these instructions will not help you build the example app or project.
3+
14
# Contributing
25

36
Contributions are always welcome, no matter how large or small!
@@ -9,7 +12,7 @@ We want this community to be friendly and respectful to each other. Please follo
912
This project is a monorepo managed using [Yarn workspaces](https://yarnpkg.com/features/workspaces). It contains the following packages:
1013

1114
- The library package in the root directory.
12-
- An example app in the `example/` directory.
15+
- An example app in the `expo-example/` directory.
1316

1417
To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:
1518

@@ -19,7 +22,7 @@ yarn
1922

2023
> Since the project relies on Yarn workspaces, you cannot use [`npm`](https://github.com/npm/cli) for development.
2124
22-
The [example app](/example/) demonstrates usage of the library. You need to run it to test any changes you make.
25+
The [example app](/expo-example/) demonstrates usage of the library. You need to run it to test any changes you make.
2326

2427
It is configured to use the local version of the library, so any changes you make to the library's source code will be reflected in the example app. Changes to the library's JavaScript code will be reflected in the example app without a rebuild, but native code changes will require a rebuild of the example app.
2528

README.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,28 @@
1-
# cbl-reactnative
1+
# React Native - Native Module for Couchbase Lite Enterprise
22

3-
Test Description
3+
This is a React Native - Native module for Couchbase Lite Enterprise. This module is a wrapper around the Couchbase Lite Enterprise SDK for iOS and Android. This module is intended to be used in React Native applications that require offline-first capabilities. This module currently uses the stable technologies defined by the legacy architecture of React Native.
44

5-
## Installation
5+
[!NOTE]
6+
This project is still a work in progress and is not officially supported by Couchbase. This is an open source project, to check the status of the project, navigate to the project's board on [GitHub - Project Status](https://github.com/orgs/Couchbase-Ecosystem/projects/2)
67

7-
```sh
8-
npm install cbl-reactnative
9-
```
8+
## Integration of Couchbase Lite Enterprise
109

11-
## Usage
10+
### Install in React Native Project
1211

12+
Documentation coming soon
1313

14-
```js
15-
import { multiply } from 'cbl-reactnative';
16-
17-
// ...
18-
19-
const result = await multiply(3, 7);
20-
```
14+
### Install in Expo Project
2115

16+
Documentation coming soon
2217

2318
## Contributing
2419

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

2722
## License
2823

29-
MIT
24+
Apache 2.0
3025

31-
---
26+
## Documentation
3227

33-
Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)
28+
Full documentation site coming soon

cbl-reactnative.podspec

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,10 @@ Pod::Spec.new do |s|
1212
s.authors = package["author"]
1313

1414
s.platforms = { :ios => min_ios_version_supported }
15-
s.source = { :git => "https://github.com/biozal/cbl-reactnative.git", :tag => "#{s.version}" }
15+
s.source = { :git => "https://github.com/Couchbase-Ecosystem/cbl-reactnative", :tag => "#{s.version}" }
1616

17+
s.swift_version = '5.5'
18+
s.dependency 'CouchbaseLite-Swift-Enterprise', '~> 3.1'
1719
s.source_files = "ios/**/*.{h,m,mm,swift}"
1820

1921
# Use install_modules_dependencies helper to install the dependencies if React Native version >=0.71.0.

0 commit comments

Comments
 (0)