From b01d20cdd851277a207c5c9d949bc74528698e96 Mon Sep 17 00:00:00 2001
From: Santiago Lo Coco <santilococo.01@gmail.com>
Date: Tue, 1 Mar 2022 17:42:53 -0300
Subject: [PATCH] Update README.md

---
 README.md | 30 +++++++++++++++++++++++++-----
 1 file changed, 25 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 5a135cc..5ab8418 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,30 @@
 # calbuilder
-GitHub action to build a package, analyze it with namcap, and output the package file and its .SRCINFO.
+GitHub action to build a package, analyze it with `namcap`, and output the package file (signed or unsigned) and its `.SRCINFO`.
 
 This action supports PKGBUILDs that have AUR dependencies.
 
+## Table of contents
+  - [Inputs and outputs <a name="io"></a>](#io-)
+  - [Usage <a name="usage"></a>](#usage-)
+  - [Contributing <a name="contributing"></a>](#contributing-)
+  - [License <a name="license"></a>](#license-)
+
 ## Inputs and outputs
-Inputs:
+### Inputs:
 * `pkgDir`: PKGBUILD directory relative path.
 * `gpgPublicKey`: GPG public key that will be used to sign packages.
 * `gpgPrivateKey`: GPG private key.
-* `gpgPassphrase`: The GPG passphrase for the gpgPrivateKey.
+* `gpgPassphrase`: The GPG passphrase for the `gpgPrivateKey`.
 
-Outputs:
+It is recommended that you store the `gpgPrivateKey` and the `gpgPassphrase` as secrets (see [Usage <a name="usage"></a>](#usage-)).
+
+None of these inputs are required. 
+
+### Outputs:
 * `srcInfo`: Generated `.SRCINFO`.
 * `pkgFile`: Built package file.
 
-## Usage
+## Usage <a name="usage"></a>
 ```yaml
 name: CI
 
@@ -27,9 +37,19 @@ jobs:
     - uses: actions/checkout@v2
     - id: calbuilder
       uses: santilococo/calbuilder@master
+        pkgDir: "libxft-bgra"
+        gpgPublicKey: "199980CE93F18E62"
+        gpgPrivateKey: "${{ secrets.GPG_PRIVATE_KEY }}"
+        gpgPassphrase: "${{ secrets.GPG_PASSPHRASE }}"
     - uses: actions/upload-artifact@v2
       with:
         path: |
           ${{ steps.calbuilder.outputs.srcInfo }}
           ${{ steps.calbuilder.outputs.pkgFile }}
 ```
+
+## Contributing <a name="contributing"></a>
+PRs are welcome.
+
+## License <a name="license"></a>
+[MIT](https://raw.githubusercontent.com/santilococo/calbuilder/master/LICENSE.md)