diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -2,3 +2,50 @@ ============== Content-addressable object storage for the Software Heritage project. + + +Quick start +----------- + +The easiest way to try the swh-objstorage object storage is to install it in a +virtualenv. Here, we will be using +[[https://virtualenvwrapper.readthedocs.io|virtualenvwrapper]]_ but any virtual +env tool should work the same. + +In the example below we will create a new objstorage using the +[[https://docs.softwareheritage.org/devel/apidoc/swh.objstorage.html#module-swh.objstorage.objstorage_pathslicing|pathslicer]] +backend. + + +``` +~/swh$ mkvirtualenv -p /usr/bin/python3 -i swh.objstorage swh-objstorage +[...] +(swh-objstorage) ~/swh$ cat >local.yml <remote.yml <