ipwb
ipwb copied to clipboard
Add sample use cases via human readable examples
The README gets into some of the technical details of the software but fails to describe a high-level use case. Having these sort of use cases might facilitate those that want to use the software without knowing the technical details to do so for their own use cases.
An example:
- Alice has a collection of archives in the form of WARCs of her homepage on her system at
/home/Alice/Documents/archive/. She wants to share these captures using ipwb. (Show a screenshot/GIF of her directory.) - She installs the software by typing
pip install ipwbusing the command-line then typesipwb index /home/Alice/Documents/archive/ > alice.cdxjto generate an index file of her WARCs. - Alice sends
alice.cdxjto Carol using the method of her choosing. Carol downloadsalice.cdxjto her system. (Screenshots of communication/email/etc.) - Carol installs ipwb by typing
pip install ipwbon the command-line. - Carol then wants to access Alice's captures, so types
ipwb replay alice.cdxj. - With the last command, ipwb said that the archive can be seen at the URL
http://localhost:5000, so Carol opens her web browser and accesses this URL. (screenshot)
These can reside on the wiki (where some of the technical details currently on the README ought to reside), with some graphical representation of a basic case in the README to potentially spark interest.