Browse Source

Add README for hanami plugin

Artem Pyankov 7 years ago
parent
commit
e64cdc9ec4
1 changed files with 6 additions and 0 deletions
  1. 6 0
      plugins/hanami/README.md

+ 6 - 0
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.