diff --git a/README.md b/README.md index e2fb791..6d7f50c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,49 @@ swh-journal =========== Persistent logger of changes to the archive, with publish-subscribe support. See the [documentation](https://docs.softwareheritage.org/devel/swh-journal/index.html#software-heritage-journal) for more details. + +# Local test + +As a pre-requisite, you need a kakfa instance. + +``` +./setup.py develop +``` + +Then, provided you are in the right virtual environment as described +in the [swh getting-started](https://docs.softwareheritage.org/devel/developer-setup.html#developer-setup): + +``` +pytest +``` + +or: + +``` +tox +``` + + +# Running + +## publisher + +Command: +``` +$ swh-journal --config-file ~/.config/swh/journal/publisher.yml \ + publisher +``` + +# Auto-completion + +To have the completion, add the following in your +~/.virtualenvs/swh/bin/postactivate: + +``` +eval "$(_SWH_JOURNAL_COMPLETE=$autocomplete_cmd swh-journal)" +```