From 023b68dd9b0a499f617ae4a16f1499e04a945ad2 Mon Sep 17 00:00:00 2001 From: Luke Macken Date: Feb 04 2016 00:07:38 +0000 Subject: README updates --- diff --git a/README.rst b/README.rst index 407ef1d..e92291e 100644 --- a/README.rst +++ b/README.rst @@ -1,9 +1,17 @@ Outhouse ======== -This is a backend daemon that listens to fedmsg and queries PDC -to determine which artifacts are affected. It will then trigger the -appropriate rebuilds of these components. +.. image:: outhouse.png + +A framework to for automatically rebuilding, testing, and releasing +products whenever their components change. + +It contains a backend daemon that listens to fedmsg and queries PDC to +determine if any artifacts are affected by a change. + +The goal is to then trigger the appropriate rebuilds of these products, +automate signing, facilitate testing, and handle syncing bits out to the +world once everything passes. Development ----------- @@ -28,7 +36,7 @@ Try running the test suite:: Check test suite coverage:: $ pip install coverage - $ nosetests --with-coverage --cover-package=pdcupdater + $ nosetests --with-coverage --cover-package=outhouse Getting an authentication token @@ -47,7 +55,7 @@ Getting an authentication token - the command should print out your token. -Copy ``fedmsg.d/pdcupdater-example.py`` to ``fedmsg.d/pdcupdater.py`` and fill +Copy ``fedmsg.d/outhouse-example.py`` to ``fedmsg.d/outhouse.py`` and fill in your token there. Running the fedmsg-hub @@ -62,7 +70,6 @@ Finally, you can take the dev instructions from `the-new-hotness set up a local fedmsg-relay so you can replay production messages and more fully test out outhouse. - -A fake bodhi update can then be sent to test the consumer:: +A fake bodhi update can then be sent to test the consumer by running:: echo '{"update": {"builds": [{"nvr": "kernel-4.3.4-200.fc24"}], "release": {"long_name": "Fedora 24"}}}' | fedmsg-logger --modname bodhi --topic update.complete.stable --json-input