search

nteract / scrapbook

A library for recording and reading data in notebooks.
https://nteract-scrapbook.readthedocs.io
BSD 3-Clause "New" or "Revised" License
281 stars 26 forks source link

Updated readme with usage and full descriptions of capabilities. #16

Closed MSeal closed 5 years ago

MSeal commented 5 years ago

This should cover all the basic usage of scrapbook in the README. Additionally I tried to update readme elements to match / pair with papermill readme docs where I could.

This will likely be the last PR before 0.1.0 is released.

betatim commented 5 years ago

Left a few comments, I am excited by this! (and a bit sad I don't have a use for it at the moment and am not contributing :( )

todo[bot] commented 5 years ago

Implement

https://github.com/nteract/scrapbook/blob/6ca6a4b2f7942459c1c6448301f2f938a6b01ae5/README.md#L152-L157

This comment was generated by todo based on a TODO comment in 6ca6a4b2f7942459c1c6448301f2f938a6b01ae5 in #16. cc @MSeal.
todo[bot] commented 5 years ago

Implement

https://github.com/nteract/scrapbook/blob/6ca6a4b2f7942459c1c6448301f2f938a6b01ae5/README.md#L155-L160

This comment was generated by todo based on a TODO comment in 6ca6a4b2f7942459c1c6448301f2f938a6b01ae5 in #16. cc @MSeal.
willingc commented 5 years ago

@MSeal Going to merge and then do a quick polish PR before 0.1.0. I think highlights works with the additional definition. Yeah I debated the same re: scraps and snaps.