diff --git a/README.md b/README.md index 048e25fc..ecb3557a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ ![Realm](https://github.com/realm/realm-js/raw/master/logo.png) 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 @@ -16,7 +16,7 @@ Please see the detailed instructions in our docs to use [Realm React Native](htt ## 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 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` - The compiled version of the Android module is here: `/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 This project adheres to the Contributor Covenant [code of conduct](https://realm.io/conduct/).