zimilar 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48c78e3c0883df0fd2de6ca1af109f5853dffe3e
-  data.tar.gz: 41a3afa994bd5e697593767013060ae574694044
+  metadata.gz: 165a018850d56fe4f4d59d5a732d97dbeee9448a
+  data.tar.gz: 06dd3e6e63eda292ee984ba732119538da0b4498
 SHA512:
-  metadata.gz: 81e6fadf3267fffc61de4158bea761cdc1ee5a83ec8684e76169ebc75ddbb26d864b96ed8eab249bbb7728d44544151a2c27cf061fc2c661fe384c99b96f3029
-  data.tar.gz: cf0f53974d8dd001f88c131974ebff6f79b8d11bde7fc4fea10ecc6e266d2ba2b07dc639f15ed4fa3a00d2337384fe21409f923acbeb49ffd29b919d7f956c55
+  metadata.gz: b5ac5c88a57b1e5a8e8dae41824ccadd9be647449ef947c4736beb2c0d9b6f46ad9e3e591b04c0ee8b50dd8a4d9aa04fd7a86b9eab6dd22d06d6830a4c5c5c85
+  data.tar.gz: 1440a20ca6c4c9659e2469962fdd4423249d74d68e0b4d620788c7ba08851173e08837aaad96b0f4e7142a12ae4b5fc6e4d5d2ba165456548fad8b1ae0fc72ed

data/README.md

@@ -1,13 +1,19 @@
 # Zimilar
 
-This small gem extends your zsh to autocorrect inputs that would led in a 'command not found'. It basically looks into your history file and tries to match the most suitable command found.
-
-There is no reason why this should only work with zsh, but I haven't tested it with other shells yet and there is currently no logic in ```zimilar``` that tries to find out your current running shell.
+This small gem extends your shell (see ```Supported Shells```) to autocorrect inputs that would led in a 'command not found'. It basically parses your history file and tries to match to most suitable command found.
 
 ```zimilar``` is just a small late-night hack I did and might be improved in the future. Its code is currently also not that optimized but for now, it works.
 
 I also think that it might be better to write this as a native shell function in order to not require ruby to be installed. As times pass by, this might change.
 
+
+## Supported Shells
+
+The following shells are supported by now:
+
+ - [zsh](http://www.zsh.org/)
+ - [bash](https://www.gnu.org/software/bash/bash.html)
+
 ## Installation
 
 Install it yourself as:
@@ -21,27 +27,53 @@ Install from source:
     $ rake build
     $ gem install pkg/zimilar-VERSION.gem
 
-Or simply copy the bin/zimilar to anywhere you want. Please ensure to install its dependencies.
+Or simply copy the ```bin/zimilar``` to anywhere you want. Please ensure to install its dependencies.
+
+
+## How it Works
+
+```zimilar``` parses your history file and compares the given command with all commands found in the history. It's using the [similar_text](https://github.com/seph/ruby-similar-text) gem to evaluate the matches.
+
+If ```zimilar``` finds a suitable match, it replaces your command and runs it.
 
 ## Usage
 
+Please be aware of that this is a nightly hack and might, under worst circumstances, destroy all you know and love. Please do not use it without having this read.
+
+```zimilar``` doesn't correct to commands with a length less or equal than 2. This is because of most 'dangerous' commands are 2 charackters long, e.g. ```cp```, ```mv```, ```rm``` and many others.
+
+But still, use it at your own risk.
+
+### zsh
 Add the following into your .zshrc or any other file that is being ```source```ed during your login:
 
-```zsh
+```bash
 function command_not_found_handler() {
   zimilar $@
 }
 ```
 
-## Example:
+### bash
+Add the following into your .bashrc or any other file that is being ```source```ed during your login:
+
+```bash
+function command_not_found_handle {
+  zimilar $@
+}
+```
+
+
+## Example
 ```
 kl@kbook:~/ $ vm
 Auto-guessed 'vim', 60.0%
 kl@kbook:~/ $
+
 ```
+
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/zimilar/fork )
+1. Fork it ( http://github.com/lotherk/zimilar/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/zimilar/version.rb

@@ -1,3 +1,3 @@
 module Zimilar
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/zimilar.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = Zimilar::VERSION
   spec.authors       = ["Konrad Lother"]
   spec.email         = ["konrad@corpex.de"]
-  spec.summary       = %q{Zimilar}
-  spec.description   = %q{Zimilar}
-  spec.homepage      = ""
+  spec.summary       = %q{This small gem extends your shell to autocorrect inputs that would led in a 'command not found'.}
+  spec.description   = %q{This small gem extends your shell to autocorrect inputs that would led in a 'command not found'.}
+  spec.homepage      = "https://github.com/lotherk/zimilar"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zimilar
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Konrad Lother
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-17 00:00:00.000000000 Z
+date: 2014-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,7 +38,8 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Zimilar
+description: This small gem extends your shell to autocorrect inputs that would led
+  in a 'command not found'.
 email:
 - konrad@corpex.de
 executables:
@@ -55,7 +56,7 @@ files:
 - lib/zimilar.rb
 - lib/zimilar/version.rb
 - zimilar.gemspec
-homepage: ''
+homepage: https://github.com/lotherk/zimilar
 licenses:
 - MIT
 metadata: {}
@@ -78,5 +79,6 @@ rubyforge_project:
 rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
-summary: Zimilar
+summary: This small gem extends your shell to autocorrect inputs that would led in
+  a 'command not found'.
 test_files: []