status-im/realm-js
2
0
Fork 0
mirror of https://github.com/status-im/realm-js.git synced 2025-01-09 05:52:24 +00:00
Code Issues Projects Releases Wiki Activity

Update Readme (#695)

Browse Source 
* Update readme

* Remove node build instructions
This commit is contained in:
Kristian Dupont 2016-12-12 14:37:06 +01:00 committed by GitHub
parent 1acbbd9708
commit 80fc4f4b13
1 changed files with 2 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,7 +1,7 @@
![Realm](https://github.com/realm/realm-js/raw/master/logo.png) ![Realm](https://github.com/realm/realm-js/raw/master/logo.png)
Realm is a mobile database that runs directly inside phones, tablets or wearables. Realm is a mobile database that runs directly inside phones, tablets or wearables.
This project hosts the JavaScript versions of [Realm](https://realm.io/). Currently we only support React Native (both iOS & Android) but we are considering adding support for Cordova/PhoneGap/Ionic as well as Node.js (V8) soon. This project hosts the JavaScript versions of [Realm](https://realm.io/). Currently we only support React Native (both iOS & Android) and Node.js (on MacOS and Linux) but we are considering adding support for Cordova/PhoneGap/Ionic as well.
## Features ## Features
@ -16,7 +16,7 @@ Please see the detailed instructions in our docs to use [Realm React Native](htt
## Documentation ## Documentation
### Realm React Native ### Realm React Native and Node.js
The documentation can be found at [realm.io/docs/react-native/latest](https://realm.io/docs/react-native/latest). The documentation can be found at [realm.io/docs/react-native/latest](https://realm.io/docs/react-native/latest).
The API reference is located at [realm.io/docs/react-native/latest/api](https://realm.io/docs/react-native/latest/api). The API reference is located at [realm.io/docs/react-native/latest/api](https://realm.io/docs/react-native/latest/api).
@ -60,15 +60,6 @@ To build for Android:
- `./gradlew publishAndroid` - `./gradlew publishAndroid`
- The compiled version of the Android module is here: `<project-root>/android` - The compiled version of the Android module is here: `<project-root>/android`
To build for Node:
- `REALM_CORE_PREFIX=/path/to/realm-core REALM_SYNC_PREFIX=/path/to/realm-sync npm install`
The `REALM_*_PREFIX` paths need to be absolute. Make sure to run `sh build.sh build-node` in both core and sync. Optionally export `REALMJS_USE_DEBUG_CORE=true` to link against the debug version of the realm binaries.
To build the Developer Edition of the module, pass `--developer_edition` to `npm install` or change the default value in `binding.gyp`.
`node-pre-gyp` is used for packaging. Run `scripts/build-node-pre-gyp.sh` with the same arguments and environment variables as `npm install` on all platforms (e.g. Linux and Darwin). Then, edit `package.json` to remove the `--build-from-source` option from the install script and run `npm pack`. Lastly, either create a fat package by merging all the tarballs created so far into one, or upload the `node-pre-gyp` tarballs to the CDN the `binary` section of `package.json` points to.
## Code of Conduct ## Code of Conduct
This project adheres to the Contributor Covenant [code of conduct](https://realm.io/conduct/). This project adheres to the Contributor Covenant [code of conduct](https://realm.io/conduct/).