From bce60a9ecf53b518c969692292e4d8fb8df1116e Mon Sep 17 00:00:00 2001
From: Santiago Lo Coco <santilococo.01@gmail.com>
Date: Sun, 27 Feb 2022 18:22:45 -0300
Subject: [PATCH] Add README.md

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e264967
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# calbuilder
+GitHub action to build PKGFILE, analyze it with namcap and output its .SRCINFO.
+
+## Inputs and outputs
+Inputs:
+* `pkgDir`: PKGBUILD directory relative path.
+
+Outputs:
+* `srcInfo`: Generated `.SRCINFO`.
+* `pkgFile`: Built package file.
+
+## Usage
+```yaml
+name: CI
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - id: makepkg
+      uses: santilococo/calbuilder@master
+    - uses: actions/upload-artifact@v2
+      with:
+        path: ${{ steps.makepkg.outputs.srcInfo }}
+        path: ${{ steps.makepkg.outputs.pkgFile }}
+```