summaryrefslogtreecommitdiff
path: root/plugins/hanami
diff options
context:
space:
mode:
authorArtem Pyankov <artpyankov@gmail.com>2016-08-19 01:18:14 +0500
committerMarc Cornellà <marc.cornella@live.com>2018-04-15 20:08:52 +0200
commite64cdc9ec40c4b98b612905cbdc6c86b14dc1fb6 (patch)
treeadc82f7275e22a9d94633abb438b5c6dab582669 /plugins/hanami
parent0bd9e5d85975f7f712f13b6178fba04a8c18d5d6 (diff)
downloadzsh-e64cdc9ec40c4b98b612905cbdc6c86b14dc1fb6.tar.gz
zsh-e64cdc9ec40c4b98b612905cbdc6c86b14dc1fb6.tar.bz2
zsh-e64cdc9ec40c4b98b612905cbdc6c86b14dc1fb6.zip
Add README for hanami plugin
Diffstat (limited to 'plugins/hanami')
-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.