summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--plugins/hanami/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/plugins/hanami/README.md b/plugins/hanami/README.md
new file mode 100644
index 000000000..20e9dd5c4
--- /dev/null
+++ b/plugins/hanami/README.md
@@ -0,0 +1,6 @@
+# Hanami Plugin #
+This plugin adds convinient ways to work with [Hanami](http://hanamirb.org/) via console. It's inspired by Rails plugin, so if you've used it, you'll be like home.
+
+## Usage ##
+For example, type `hc` into your console when you're within Hanami project directory to run application console.
+You can read about available commands [here](http://hanamirb.org/guides/command-line/applications/), almost all of them have shortcut aliases with this plugin.