Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #3

Closed
vadimdemedes opened this issue Aug 25, 2012 · 2 comments
Closed

Documentation #3

vadimdemedes opened this issue Aug 25, 2012 · 2 comments

Comments

@vadimdemedes
Copy link

Hello, first of all, thank you for an awesome library. But I can't find even "Getting Started" guide or simple code examples(without complete demo app). Could you please add at least that? Thank you!

@ddustin
Copy link

ddustin commented Mar 21, 2014

There is an example project that makes it pretty clear. Also the code looks pretty clean and well written. I don't think documentation is needed!

@rsms
Copy link
Owner

rsms commented Mar 22, 2014

As @ddustin points out, there's both a "getting started" summary (https://github.com/rsms/peertalk#getting-started) as well as a complete demo suite ("Peertalk Example" is the OS X part and "Peertalk iOS Example" is the iOS part.)

Unfortunately the demo apps are using all features which makes the code size a fair bit larger than the absolute minimum. I'd recommend starting with building and playing with the demo apps and from there understand what's going on (read the code, which contains some amount of comments, as well as fairly readable objc message names.)

@rsms rsms closed this as completed Mar 22, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants