Merge pull request #4 from mrodalgaard/add-readme

Add basic readme with screenshot
Cloudstek · Dec 15, 2016 · 5154c8a · 5154c8a
2 parents 0ab3c5d + 782b883
commit 5154c8a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,14 @@
+# Alfred Atom Workflow
+
+Simple workflow that allows you to browse and open [Atom](https://atom.io/) projects.
+
+## Requirements
+
+* [NodeJS](https://nodejs.org/)
+* [Atom Project Manager package](https://atom.io/packages/project-manager)
+
+## Usage
+
+Simply type <kbd>atom</kbd> followed by space to list all projects. Optionally type a search string to filter results.
+
+![alfred-atom](doc/screenshot.png)
diff --git a/doc/screenshot.png b/doc/screenshot.png