search

census-instrumentation / opencensus-go

A stats collection and distributed tracing framework
http://opencensus.io
Apache License 2.0
2.06k stars 327 forks source link

Move the code snippets from README to godoc #19

Closed rakyll closed 6 years ago

rakyll commented 7 years ago

Go provides testable examples. Move the snippets to the godoc examples. In the alpha stage, while the APIs are being broken often, it will help us to keep the examples up to date.

acetechnologist commented 7 years ago

Sounds good to me. /cc @jcd2 @bogdandrutu for input

bogdandrutu commented 7 years ago

Having examples always up to date is great. I think this is a good idea.

rakyll commented 6 years ago

I need we can keep both. I am suggesting to use a tool like embedmd to generate the README with up-to-date examples that compiles all the time.