readme

kudrykv · Jul 5, 2021 · fdde243 · fdde243
1 parent d6366bf
commit fdde243
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,27 @@
+# CraftDocs Workflow
+
+Search in Craft document with Craft Search Index.
+
+## Install
+Download the latest release, double-click it and proceed with Alfred instructions.
+Use `amd64` for Intel chips and `arm64` for M1 chips.
+
+## Authorization
+The first time you use the workflow after install or update, you will see the security warning:
+<img alt="unidentified developer security warning" src="security_warning.jpeg" width="400">
+
+This is a quirk of MacOS 10.15 and above.
+
+After seeing this warning, you have to go to
+`System Preferences > Security & Privacy > General`
+and click the new button that has appeared to allow the executable to run.
+You then have to run it again, and you will see this security warning again,
+but now it will have a new button that lets you allow the executable to run.
+
+## Search
+Run `cs <query>` to look for documents.
+It opens the page with the result.
+
+![](search_1.png)
+
+![](search_2.png)
diff --git a/search_1.png b/search_1.png
diff --git a/search_2.png b/search_2.png
diff --git a/security_warning.jpeg b/security_warning.jpeg