diff --git a/README.md b/README.md index 1244961..ce5a7a7 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [TOC] ## Synopsis ## -The Parse platform provides a complete backend solution for your mobile application. Parse provides a REST API as well as libraries for different mobile platforms like Android and iOS. CodenameOne (CN1 for short) on the other hand is a great framework for cross-platform mobile application development. Although some of the functionality provided by Parse is offered to *paying* CN1 users, integration of third-party libraries is allowed and even encouraged in CN1. This project aims at making the Parse platform available to CN1 apps thereby giving developers more options for cloud-based backend solutions in CN1. In order to maximize platform support, this library aims at implementing the REST API specification rather than for instance, integrating the existing Parse native libraries for various platforms. Of course, where possible, advanced features that go beyond the REST API (e.g., background operations) will also be supported by this library provided they can be implemented in a generic manner. Since CN1 is written in Java, this library can also be used in pure Java projects as illustrated [here](https://bitbucket.org/sidiabale/parse4cn1/wiki/Usage%20examples#markdown-header-using-parse4cn1-in-a-regular-java-project). +The Parse platform provides a complete backend solution for your mobile application. Parse provides a REST API as well as libraries for different mobile platforms like Android and iOS. CodenameOne (CN1 for short) on the other hand is a great framework for cross-platform mobile application development. Although some of the functionality provided by Parse is offered to *paying* CN1 users, integration of third-party libraries is allowed and even encouraged in CN1. This project aims at making the Parse platform available to CN1 apps thereby giving developers more options for cloud-based backend solutions in CN1. In order to maximize platform support, this library aims at implementing the REST API specification rather than for instance, integrating the existing Parse native libraries for various platforms. Of course, where possible, advanced features that go beyond the REST API (e.g., background operations) will also be supported by this library provided they can be implemented in a generic manner. Since CN1 is written in Java, this library can also be used in pure Java projects as illustrated [here](https://github.com/sidiabale/parse4cn1/wiki/Usage-Examples#using-parse4cn1-in-a-regular-java-project). ## License ## Apache License, [Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) @@ -37,7 +37,7 @@ The Parse RESTAPI is quite extensive. As such, we maintain an overview of the fu | GeoPoints | Pending | | ## Usage Examples ## -See [[Usage examples]] +See [Usage examples](https://github.com/sidiabale/parse4cn1/wiki/Usage-Examples) ## Contributing ## Contributing to this project is most welcome; the more, the merrier! Simply fork the master branch, implement a feature / bug fix and initiate a pull request. Please bear the following in mind though to ensure smooth and timely integration of your changes: @@ -48,11 +48,11 @@ Contributing to this project is most welcome; the more, the merrier! Simply fork 1. Document at least all public facing methods with comments that add value (not simply boilerplate comments that state the obvious). -1. Write tests for added functionality (see the /test directory for some inspiration if needed). +1. Write tests for added functionality (see the [test directory](https://github.com/sidiabale/parse4cn1/tree/master/test) for some inspiration if needed). 1. Make sure all tests are passing before issuing a pull request. Furthermore, it's handy, at the time you pick up a feature, to mention it so that others can see what's in progress and efforts can be consolidated (there's little or no value in having multiple implementations of the same feature going on in parallel). So update the coverage table above with what you're working on as well as an estimate of when you expect it to be done. If you can't update this page directly, just create a ticket with the information and this page will be updated for you. Thanks! ## Credits ## 1. Thiago Locatelli's [Parse4J](https://github.com/thiagolocatelli/parse4j) project [(version 1.3)](https://github.com/thiagolocatelli/parse4j/releases/tag/parse4j-1.3) from which the initial design and implementation of Parse4CN1 were adapted. -2. Steve Hannah's [CN1JSON library](https://github.com/shannah/CN1JSON). \ No newline at end of file +2. Steve Hannah's [CN1JSON library](https://github.com/shannah/CN1JSON).