README.md in vagrant_hook-0.1.0 vs README.md in vagrant_hook-0.1.1
- old
+ new
@@ -1,35 +1,21 @@
-# Vagranthook
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/vagranthook`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'vagranthook'
-```
-
-And then execute:
-
- $ bundle
-
-Or install it yourself as:
-
- $ gem install vagranthook
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/vagranthook.
+# Vagranthook
+
+This project proves how to create a basic plugin that can hook to a specific event chain.
+
+It is a base, so that in the future it can support further events.
+
+Feel free to contribute.
+
+# Installation
+
+> vagrant plugin install vagrant_hook
+
+# How to use
+
+In your vagrant box add something like:
+
+```ruby
+config.vagrant_hook.check_outdated do |host|
+ puts "hello world!"
+end
+```