Permalink
Browse files

Create README.md

Add simple readme
  • Loading branch information...
1 parent df61f96 commit 8309314f21c2be5a416b6e4988ac59e0a103b566 @divoxx committed Jan 3, 2013
Showing with 32 additions and 0 deletions.
  1. +32 −0 README.md
View
@@ -0,0 +1,32 @@
+rails-branch-migrator
+=====================
+
+Automatically runs rails migrations (up/down) when switching between git branches, only loading the rails app when there are migrations to be run.
+
+Installation
+------------
+
+Run the following from inside the git project's root folder:
+
+```bash
+curl "https://raw.github.com/divoxx/rails-branch-migrator/master/install.sh" | bash
+```
+
+It will copy four files into your .git/hooks/ folder:
+
+* post-checkout
+* post-merge
+* detect-ruby
+* update_migrations.rb
+
+Notes
+=====
+
+This is a very simple and hacked implementation but I've been using this successfully for the past months.
+
+I don't have any current plans on improving it but feel free to fork it.
+
+License
+=======
+
+The MIT License

0 comments on commit 8309314

Please sign in to comment.