status-im
/
realm-js
mirror of https://github.com/status-im/realm-js.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix some typos and wording issues in README

This commit is contained in:
Scott Kyle 2016-02-17 18:19:24 -08:00
parent c3450248b9
commit 6f449b2c66
2 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -15,10 +15,10 @@ When filing an issue, please provide as much of the following information as pos
If you'd like to send us sensitive sample code to help troubleshoot your issue, you can email <help@realm.io> directly.
## Contributing Enhancements
We love contributions to Realm! If you'd like to contribute code, documentation, or any other improvements, please [file a Pull Request](https://github.com/realm/realm-js/pulls) on our GitHub repository. Make sure to accept our [CLA](#CLA)
We love contributions to Realm! If you'd like to contribute code, documentation, or any other improvements, please [file a Pull Request](https://github.com/realm/realm-js/pulls) on our GitHub repository. Make sure to accept our [CLA](#cla)
### Commit Messages
Although we don’t enforce a strict format for commit messages, we prefer that you follow the guidelines below, which are common among open source projects. Following these guidelines helps with the review process, searching commit logs and documentation of implementation details. At a high level, the contents of the commit message should convey the rationale of the change, without delving into much detail. For example, `setter names were not set right` leaves the reviewer wondering about which bits and why they weren’t “right”. In contrast, `[RLMProperty] Correctly capitalize setterName` conveys almost all there is to the change.

18
README.md
View File

@ -1,22 +1,21 @@
![Realm](https://github.com/realm/realm-cocoa/raw/master/logo.png)
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 React Native and Apache Cordova (PhoneGap).
This repository holds the source code for Realm's JavaScript bindings for integrating with mobile apps built using React Native.
Currently this repository only supports React Native, but will expand to other Javascript solutions soon.
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.
## Features
* **Mobile-first:** Realm is the first database built from the ground up to run directly inside phones, tablets and wearables.
* **Simple:** Data is directly [exposed as objects](https://realm.io/docs/react-native/latest/#models) and [queryable by code](https://realm.io/docs/react-native/latest/#queries), removing the need for ORM's riddled with performance & maintenance issues.
* **Modern:** Realm supports relationships, generics,and vectorization.
* **Modern:** Realm supports relationships, generics, and vectorization.
* **Fast:** Realm is faster than even raw SQLite on common operations, while maintaining an extremely rich feature set.
## Getting Started
Please see the detailed instructions in our docs to add [Realm React Native](https://realm.io/docs/react-native/latest/#installation)
## Documentation
### Realm React Native
@ -26,10 +25,10 @@ The API reference is located at [realm.io/docs/react-native/latest/api](https://
## Getting Help
- **Need help with your code?**: Look for previous questions on the [#realm tag](https://stackoverflow.com/questions/tagged/realm?sort=newest) — or [ask a new question](https://stackoverflow.com/questions/ask?tags=realm). We activtely monitor & answer questions on SO!
- **Have a bug to report?** [Open an issue](https://github.com/realm/react-native/issues/new). If possible, include the version of Realm, a full log, the Realm file, and a project that shows the issue.
- **Have a feature request?** [Open an issue](https://github.com/realm/react-native/issues/new). Tell us what the feature should do, and why you want the feature.
- Sign up for our [**Community Newsletter**](http://eepurl.com/VEKCn) to get regular tips, learn about other use-cases and get alerted of blogposts and tutorials about Realm.
- **Need help with your code?**: Look for previous questions on the [#realm tag](https://stackoverflow.com/questions/tagged/realm?sort=newest) — or [ask a new question](https://stackoverflow.com/questions/ask?tags=realm). We actively monitor and answer questions on SO!
- **Have a bug to report?** [Open an issue](https://github.com/realm/realm-js/issues/new). If possible, include the version of Realm, a full log, the Realm file, and a project that shows the issue.
- **Have a feature request?** [Open an issue](https://github.com/realm/realm-js/issues/new). Tell us what the feature should do, and why you want the feature.
- Sign up for our [**Community Newsletter**](http://eepurl.com/VEKCn) to get regular tips, learn about other use-cases and get alerted of blog posts and tutorials about Realm.
## Building Realm
NEEDS TO BE EDITED!!
@ -37,6 +36,7 @@ NEEDS TO BE EDITED!!
![TBD](http://usaction.org/wp-content/uploads/2011/11/Work_That_Needs_Doing.png)
## Conduct
This project adheres to the Contributor Covenant [code of conduct](https://realm.io/conduct/).
By participating, you are expected to uphold this code. Please report unacceptable behavior to [info[at]realm.io](mailto:info+conduct@realm.io).
@ -46,7 +46,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for more details!
## License
Realm Objective-C & Realm Swift are published under the Apache 2.0 license.
Realm JS is published under the Apache 2.0 license.
The underlying core is available under the [Realm Core Binary License](https://github.com/realm/realm-cocoa/blob/master/LICENSE#L210-L243) while we [work to open-source it under the Apache 2.0 license](https://realm.io/docs/react-native/latest/#faq).
**This product is not being made available to any person located in Cuba, Iran,