Enrich readme
authorSofian Brabez <sofian.brabez@gonitro.com>
Thu, 6 Jun 2019 17:04:34 +0000 (18:04 +0100)
committerSofian Brabez <sofian.brabez@gonitro.com>
Thu, 5 Sep 2019 13:48:12 +0000 (14:48 +0100)
README.md

index b480147c870aa3d4f92ce5f836033c22e05d6589..bedaed964eb4065f6eb96b2be89e47005144eb45 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,11 @@
 # docker-gc-build
 
+This project help us to build using [Docker][1] container a new [docker-gc][2] debian package release
+signed.
+
 ## Requirements
 
-- [deb-s3](/krobertson/deb-s3) to upload your debian package artifact in the s3-bucket
+- [deb-s3](/krobertson/deb-s3) to upload your debian package artifact into the target s3-bucket
 - [gnupg](https://formulae.brew.sh/formula/gnupg) to sign the package
 
 ## Usage
@@ -11,17 +14,26 @@ Build debian package into an isloated docker container and sign it with
 passphrase:
 
 ```sh
-./release.sh
+./release.sh -h
 ```
 
 Just executing a [Dry-run](https://en.wikipedia.org/wiki/Dry_run_(testing)):
 
 ```sh
-DRY_RUN=echo ./release.sh
+./release.sh -s
 ```
 
 List repos packages
 ```
 deb-s3 list --bucket=$BUCKET
 aws s3 ls --recursive s3://$BUCKET
-```
\ No newline at end of file
+```
+
+## License
+
+This project is released under MIT license.
+
+Copyright (c) 2018 Nitro Software
+
+[1]: https://www.docker.com/resources/what-container
+[2]: https://github.com/spotify/docker-gc