Add README file

omerdn1 · Sep 5, 2022 · a7e4ebf · a7e4ebf
1 parent 4e3f69b
commit a7e4ebf
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+# alfred-qr
+Alfred workflow for scanning and decoding QR codes by taking a snapshot, Built in Rust
+
+<p align="center"><a href="https://github.com/omerdn1/alfred-qr/releases/"><img src="screenshot.png"/></a></p>
+
+## Commands
+
+* `qr`: promts you to take a screenshot of a QR Code. Once the QR has been decoded, a notification will show, and the result will be saved to the clipboard
+
+## [Download .alfredworkflow](https://github.com/omerdn1/alfred-qr/releases/) 
+
+### Rebuild binary and alfred workflow
+
+```
+./build-workflow.sh
+open alfred-qr.alfredworkflow
+```
+
diff --git a/screenshot.png b/screenshot.png