diff --git a/README.md b/README.md index 10f4d56a..d7f749c5 100644 --- a/README.md +++ b/README.md @@ -184,6 +184,16 @@ take a longer time to run (relating to the storage of large files) - to execute ## HashStore Client +Client API Options: +- `-getchecksum` (get_hex_digest) +- `-findobject` +- `-storeobject` +- `-storemetadata` +- `-retrieveobject` +- `-retrievemetadata` +- `-deleteobject` +- `-deletemetadata` + How to use HashStore client (command line app) ```sh # Step 1: Create a HashStore @@ -192,6 +202,9 @@ $ python './src/hashstore/hashstoreclient.py' /path/to/store/ -chs -dp=3 -wp=2 - # Get the checksum of a data object $ python './src/hashstore/hashstoreclient.py' /path/to/store/ -getchecksum -pid=content_identifier -algo=SHA-256 +# Find an object (returns the content identifier) +$ python './src/hashstore/hashstoreclient.py' /path/to/store/ -findobject -pid=content_identifier + # Store a data object $ python './src/hashstore/hashstoreclient.py' /path/to/store/ -storeobject -pid=content_identifier -path=/path/to/object