comtihon / mongodb-erlang

MongoDB driver for Erlang
Apache License 2.0
341 stars 267 forks source link

Update README to show proper `mongoc:connect/3` args #231

Closed dmsnell closed 3 years ago

dmsnell commented 3 years ago

Resolves #206

The README has been showing confusing information for mongoc, namely suggesting to connect through mongo_api:connect/4 but describing the Seed parameter from mongoc as if it were part of the mongo_api method, which it is not.

In this patch I've updated the README so that it describes the use of mongoc:connect/3 instead of mongo_api:connect/4 as hinted at by the descriptive text above the example.

Additionally I have made small edits to the mongoc area:

dmsnell commented 3 years ago

@comtihon the failures in this branch are unrelated as they are existing and I have only changed README.md

comtihon commented 3 years ago

I'll fix the build today (old rebar issue) Thanks for the PR! I'll merge it as soon as build becomes green.

comtihon commented 3 years ago

Can you please rebase on latest master?

comtihon commented 3 years ago

actually, never mind. it is readme only change

dmsnell commented 3 years ago

Thanks @comtihon