Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
danielmorrison committed May 4, 2011
1 parent 2d98610 commit be41eb6
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 7 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG
@@ -0,0 +1,3 @@
2.0.0.pre
* Expect Rails 3
* Switched to RSpec
2 changes: 1 addition & 1 deletion MIT-LICENSE
@@ -1,4 +1,4 @@
Copyright (c) 2007 [name of plugin creator]
Copyright (c) 2007-2011 Collective Idea

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
Expand Down
13 changes: 7 additions & 6 deletions README.rdoc
@@ -1,16 +1,18 @@
= AwesomeNestedSet

Awesome Nested Set is an implementation of the nested set pattern for ActiveRecord models. It is replacement for acts_as_nested_set and BetterNestedSet, but awesomer. It supports Rails 2.1 and later.
Awesome Nested Set is an implementation of the nested set pattern for ActiveRecord models. It is replacement for acts_as_nested_set and BetterNestedSet, but more awesome.

Version 2 supports Rails 3. Gem versions prior to 2.0 support Rails 2.

== What makes this so awesome?

This is a new implementation of nested set based off of BetterNestedSet that fixes some bugs, removes tons of duplication, adds a few useful methods, and adds STI support.

== Installation

Install as a plugin:
Add to your Gemfile:

script/plugin install git://github.com/collectiveidea/awesome_nested_set.git
gem 'awesome_nested_set'

== Usage

Expand All @@ -37,15 +39,15 @@ Enable the nested set functionality by declaring acts_as_nested_set on your mode
acts_as_nested_set
end

Run `rake rdoc` to generate the API docs and see CollectiveIdea::Acts::NestedSet::SingletonMethods for more info.
Run `rake rdoc` to generate the API docs and see CollectiveIdea::Acts::NestedSet::Model::SingletonMethods for more info.

== Conversion from other trees

Coming from acts_as_tree or another system where you only have a parent_id? No problem. Simply add the lft & rgt fields as above, and then run

Category.rebuild!

Your tree be converted to a valid nested set. Awesome!
Your tree will be converted to a valid nested set. Awesome!

== View Helper

Expand All @@ -65,7 +67,6 @@ You can learn more about nested sets at:

http://www.dbmsmag.com/9603d06.html
http://threebit.net/tutorials/nestedset/tutorial1.html
http://api.rubyonrails.com/classes/ActiveRecord/Acts/NestedSet/ClassMethods.html
http://opensource.symetrie.com/trac/better_nested_set/

== How to contribute
Expand Down

0 comments on commit be41eb6

Please sign in to comment.