Update readme
authorSofian Brabez <sofian.brabez@gonitro.com>
Tue, 4 Dec 2018 15:57:03 +0000 (15:57 +0000)
committerSofian Brabez <sofian.brabez@gonitro.com>
Tue, 4 Dec 2018 16:08:02 +0000 (16:08 +0000)
README.md

index 6520c590ccc9481be48bfa1ccd4ae6e2fab5965e..e6019af67ca2f7143172c9a2078e0bcea13d3c27 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,21 @@
-# docker-gc-build
\ No newline at end of file
+# docker-gc-build
+
+## Requirements
+
+- [deb-s3](/krobertson/deb-s3) to upload your debian package artifact in the s3-bucket
+- [gnupg](https://formulae.brew.sh/formula/gnupg) to sign the package
+
+## Usage
+
+Build debian package into an isloated docker container and sign it with
+passphrase:
+
+```sh
+./release.sh
+```
+
+Just executing a [Dry-run](https://en.wikipedia.org/wiki/Dry_run_(testing)):
+
+```sh
+DRY_RUN=echo ./release.sh
+```
\ No newline at end of file