From 76f2ed5254ada5d520d27364c621769e7109f186 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jes=C3=BAs?= Date: Mon, 12 Apr 2021 12:49:45 -0500 Subject: [PATCH] [README.md]: update syntax --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cc2df3a..3776b9c 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ A small git-integrated script to sign a repository archive tarball for use with ## Usage - git-snapsign [--dry-run] [--force] [-s ] [-F ] [-p ] -t +```console +$ git-snapsign [--dry-run] [--force] [-s ] [-F ] [-p ] -t +``` `git-snapsign` will create a detached signature for archive output from `git-archive(1)` for `` and add it to the tag's notes in the @@ -49,18 +51,26 @@ the snapshots it offers on the repository's summary page. Create a signature for the archive tarball at tag v1.0.0. - git-snapsign -t v1.0.0 +```console +$ git-snapsign -t v1.0.0 +``` Same as above but use the zip format. - git-snapsign -F zip -t v1.0.0 +```console +$ git-snapsign -F zip -t v1.0.0 +``` Create a signature with the key corresponding to heckyel@hyperbola.info - git-snapsign -s 4DF21B6A7C1021B25C360914F6EE7BC59A315766 -t v1.0.0 +```console +$ git-snapsign -s 4DF21B6A7C1021B25C360914F6EE7BC59A315766 -t v1.0.0 +``` Use "linux-libre-lts" to create the archive prefix. Useful for when the repository basename is not the canonical name of the project. For example, the linux-libre-lts project may wish to set the prefix this way. - git-snapsign -p linux-libre-lts -t v5.4.96 +```console +$ git-snapsign -p linux-libre-lts -t v5.4.96 +```