write readme

[condenast]

write readme

[gautamarora]

the readme is really great!
@taveras @pgoldrbx - incase you want to stick to this readme format, I would recommend planning a short intro blog post (for technology.condenast.com) to announce the library and make the case for why someone could use it.

My recommendation to think of the readme/blogpost together was to reduce the amount of documentation to be created for open sourcing a project.

[gautamarora]

since this issue was created primarily to address one of my recommendations on thinking of the readme like a blog post, we have since moved to using the readme checklist (as listed in #23) for the readme. If there are any recommendations for updating the checklist itself, we should handle that in the open source templates https://github.com/CondeNast/evangelism/tree/master/open-source/templates.

Closing this.

[taveras]

#9 is an excellent start. we'll need to revisit this to make this read similar to a blog post, per @gautamarora 's recommendation

[pgoldrbx]

@gautamarora I have no particular thoughts/opinions on README format. I'd love to have some kind of "best practice" guide for READMEs in general, not just for OSS

[gautamarora]

@pgoldrbx checkout the readme checklist https://github.com/CondeNast/evangelism/blob/master/open-source/templates/CHECKLIST.md#readme-checklist