search

Kapelianovych / couchdb_dart

A library for Dart developers for work with CouchDB
https://pub.dev/packages/couchdb
Other
47 stars 18 forks source link

Please consider updating the doc #17

Open toyssamurai opened 3 years ago

toyssamurai commented 3 years ago

It took me almost 30 mins to find out how to specify the host. The doc gives the following sample codes:

final c = CouchDbClient(username: 'name', password: 'pass');

Throughout the entire documentation, there's no mentioning of setting the host address. Even the example shows nothing about setting the host.

Yes, it's in the API doc of the CouchDbClient class and the test codes, but not having it in the main doc is very confusing.

bean5 commented 3 years ago

@YevhenKap I agree that updating the documentation could be helpful in relation to this.