search

couchbaselabs / Couchbase-Lite-PhoneGap-Plugin

Plugin to install Couchbase Lite in your PhoneGap app on iOS or Android
183 stars 67 forks source link

poor documentation for PG plugin? #28

Open siddo420 opened 10 years ago

siddo420 commented 10 years ago

There is just that TodoLite app but that is not enough as it does not explain how the code works. For example, how to create a new user or use hte old one. The code uses other modules (browserified) like pax etc but code isn't straight forward to read and understand and obviously you don't learn concepts and pitfalls by just looking at the code. Please provide proper documentation other than the REST API as that also doesn't explain how to create a new local user and why a user is required etc.

perqa commented 9 years ago

I am really interested in using this plugin, but the Javascript API documentation is missing over at http://developer.couchbase.com/mobile/develop/guides/couchbase-lite/native-api/replication/index.html There is excellent documentation for Objective-C, Swift, Java, Android and C#, but none for Javascript.

Also, the URL for "Javascript<->Native bridge, to ask it what URL it has launched on for subsequent XHR access", given in the project Readme here at Github, is dead.

jfspencer commented 9 years ago

I would love to see better Javascript documentation as well. How can the community help?

shyleshmv commented 8 years ago

I am also searching for JavaScript documentation. If anyone have Couchbase Lite + Cordova app tutorial then share it here

jfspencer commented 8 years ago

@shyleshmv @siddo420 @perqa I ended up writing an adapter over the rest api. The repo is here. I have some basic documentation in the readme. let me know if you have any improvement suggestions. I am using it in a production application and has been working well.

The code is written in typescript so you can compile it down yourself or you can use this reference app which will compile it for you.

feedback/pull requests always welcome.