status-im/realm-js
2
0
Fork 0
mirror of https://github.com/status-im/realm-js.git synced 2025-01-22 20:41:18 +00:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Ari Lazier 2015-10-27 14:40:45 -07:00
parent 72cf0910d5
commit 70d2a6b7d8
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,13 +1,13 @@
# RealmJS
Realm is a mobile database that runs directly inside phones, tablets or wearables. This repository holds the source code for Realm's JavaScript bindings for integrating with mobile apps built using ReactNative and PhoneGap.
RealmJS contains Realm bindings for integrating with mobile apps built using javascript frameworks such as ReactNative and PhoneGap.
RealmJS uses submodules so you need to run `git submodule update --init --recursive` in the realm-js root directory before running any examples or including the project in your app.
# Setup
This repository uses submodules so you need to run `git submodule update --init --recursive` in the realm-js root directory before running any examples or including the project in your app.
## ReactNative Example
Make sure your environment is set up to run react native applications. Follow the instructions here https://facebook.github.io/react-native/docs/getting-started.html to the point you have installed the react-native-cli.
Make sure your environment is set up to run react native applications. Follow the instructions here https://facebook.github.io/react-native/docs/getting-started.html.
The ReactNative sample project is in the `examples/ReactExample` directory. You must run `npm install` in this directory before running the example for the first time.
The ReactNative exampoe project is in the `examples/ReactExample` directory. You need to run `npm install` in this directory before running the example for the first time.
## ReactNative Project Setup
- Create a new ReactNative project `react-native init <project-name>` and open the generated XCode project.
@ -16,3 +16,9 @@ The ReactNative sample project is in the `examples/ReactExample` directory. You
- Use Realm in your app.
- Drag `RealmJS.framework` from the `Products` directory under `RealmJS.xcodeproj` into the `Embedded Libraries` section in the `General` tab for you app's target settings. This bundles the library with your app.
## Documentation
Currently there is no documentation for the current apis. You can see examples of how to use the apis in the example app and in the js test files here: https://github.com/realm/realm-js/tree/master/tests
# License
Copyright 2015 Realm Inc - All Rights Reserved
Proprietary and Confidential