search

liftbridge-io / go-liftbridge

Go client for Liftbridge. https://github.com/liftbridge-io/liftbridge
Apache License 2.0
66 stars 18 forks source link

Documentations for v2 client #92

Open LaPetiteSouris opened 3 years ago

LaPetiteSouris commented 3 years ago

I'm wondering if we should dedicate some times to v2 documentation ?

tylertreat commented 3 years ago

I think so. The changes aren't substantial between v1 and v2. Mainly just the introduction of PublishAsync and some minor changes to returned errors in parts of the API (which is what necessitated the major version bump).

LaPetiteSouris commented 3 years ago

Actually I was looking for a slot to put some note/docs for the FetchPartitionMetadata function and I could not find the right one, as v1 readme seems not to be the right one and v2 read me is not there yet. That's why I created the issue

tylertreat commented 3 years ago

I see. Yes, we can create a separate v2 readme.