Permalink
Browse files

Added license and readme

  • Loading branch information...
1 parent b29ab39 commit 17f2120fb0aaf238f90193aba3906bfa2314e9a6 @andrew committed Jun 5, 2011
Showing with 64 additions and 1 deletion.
  1. +20 −0 LICENSE
  2. +44 −1 Readme.mdown
View
@@ -0,0 +1,20 @@
+Copyright (c) 2011 Andrew Nesbitt
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -5,4 +5,47 @@ Blogging plugin provided as a rails engine
## Requirements
* A rails 3.0.x app
-* Postgres database
+* Postgres database
+
+## Install
+
+Add bumble to your `Gemfile`:
+
+ gem 'bumble'
+
+and update your bundle:
+
+ $ bundle install
+
+Then you can add the migrations and assets to your project with the following generators:
+
+ $ rails generate bumble:migrations
+ $ rails generate bumble:assets
+
+The last step is then to run those new migrations:
+
+ rake db:migrate
+
+## Customisation
+
+You can mount the blog in a particular route (the default is /posts) by putting the following in your `config/routes.rb` in your application:
+
+ match '/blog', :to => 'posts#index'
+
+To make the blog your homepage use:
+
+ root :to => 'posts#index'
+
+## Note on Patches/Pull Requests
+
+ * Fork the project.
+ * Make your feature addition or bug fix.
+ * Add tests for it. This is important so I don't break it in a
+ future version unintentionally.
+ * Commit, do not mess with rakefile, version, or history.
+ (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+ * Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2011 Andrew Nesbitt. See LICENSE for details.

0 comments on commit 17f2120

Please sign in to comment.