Skip to content
This repository has been archived by the owner on Jan 8, 2020. It is now read-only.

Improve docs regarding examples #75

Closed
aklinkert opened this issue Sep 13, 2016 · 2 comments
Closed

Improve docs regarding examples #75

aklinkert opened this issue Sep 13, 2016 · 2 comments

Comments

@aklinkert
Copy link

Hey all,

first of all thanks for this awesome library! I's actually saving A LOT of time! 💪

Unfortunately there is a small lack of documentation regarding examples - READMY says Documentation and example are available via godoc [..] but godoc doesn't contain examples?

I've got my consumer implementation running, but this was paired with a lot of reading sarama-clusters source code and the cli tool, which should be the case, no? Would be great if you/we could add some examples to docs. :)

Have a nice day and greetings from Germany!
Alex

@aklinkert aklinkert changed the title Improve docs Improve docs regarding examples Sep 13, 2016
@dim
Copy link
Member

dim commented Nov 2, 2016

I would really appreciate some help with documentation and examples. Could you please submit a (separate) pull request?

@dim dim closed this as completed Nov 2, 2016
@aklinkert
Copy link
Author

I'm not seeing this one closed. I'd close this one as soon as the PR is merged? Anyway, I'll try and tackle this asap.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants