gallantlab / cottoncandy

sugar for s3
http://gallantlab.github.io/cottoncandy/
BSD 2-Clause "Simplified" License
33 stars 16 forks source link

docs in README #53

Closed alexhuth closed 6 years ago

alexhuth commented 6 years ago

The docs right now are quite nice: http://gallantlab.github.io/cottoncandy/

but the README.md leaves a lot to be desired. I think it'd be great if a lot of the content from the front page of the docs (Install, Getting Started, basic usage) was replicated in the README.

I would do this myself and make a PR if I had the gumption.. sorry

anwarnunez commented 6 years ago

good point! I'll take care of it