4 ms·
https://github.com/mcohen01/amazonica https://github.com/mcohen01/amazonica is the best README I've seen. Relevant examples for every piece of the library, and
by bpicolo 9y ago
https://github.com/mcohen01/amazonica https://github.com/mcohen01/amazonica is the best README I've seen. Relevant examples for every piece of the library, and some nice-to-have performance graphs. The 95%-use-case getting started is really the best thing you can do in a README in my opinion, and amazonica totally nails it.
- Sujan 9y agoI like how the project name is formatted as code. It's missing a TOC though, scrolling through it doesn't give an overview what it contains.
- bpicolo 9y agoThe "Supported Services" is the table of contents
- Sujan 9y agoIf this is the intention, then it is a really terrible one. First link sends me 1/3 down the page. This actually only links to the examples, the 10 other (documentation) sections/headlines are missing.
- bpicolo 9y agoYeah, that could maybe be tweaked a bit. The examples are really where this one shines for me. :) I didn't feel more ToC was overly necessary.