README.md in can_be-0.3.0 vs README.md in can_be-0.4.0

- old
+ new

@@ -4,11 +4,11 @@ Here is a blog post that will describe more of the rationale behind the CanBe gem: [http://blog.markstarkman.com/blog/2013/01/09/writing-my-first-rubygem-canbe/](http://blog.markstarkman.com/blog/2013/01/09/writing-my-first-rubygem-canbe/) ## Versioning -I will be following [Semantic Versioning](http://semver.org/) as closely as possible. The `master` branch will be the latest development version and may not match the version of the code you are using. There is a git tag for each released version. The [CHANGELOG.md](https://github.com/mstarkman/can_be/blob/master/CHANGELOG.md) will contain the correct links to each version. +I will be following [Semantic Versioning](http://semver.org/) as closely as possible. The `master` branch will be the latest development version and may not match the version of the code you are using. There is a git tag for each released version. The [CHANGELOG.md](CHANGELOG.md) will contain the correct links to each version. ## Installation Add this line to your application's Gemfile: @@ -24,13 +24,13 @@ ## Documentation The documentation for the basic implementation of CanBe can be found in this readme. Here is the documentation for the other features. -* [Different Attributes per CanBe Type (details)](https://github.com/mstarkman/can_be/blob/master/docs/details.md) -* [Keeping Details History When Changing CanBe Types](https://github.com/mstarkman/can_be/blob/master/docs/history.md) -* [Custom RSpec Matchers](https://github.com/mstarkman/can_be/blob/master/docs/rspec_matcher.md) +* [Different Attributes per CanBe Type (details)](docs/details.md) +* [Keeping Details History When Changing CanBe Types](docs/history.md) +* [Custom RSpec Matchers](docs/rspec_matcher.md) ## Database Configuration (via migrations) In its simplest form, you only need to add a string attribute (column) to the model can be different types. By default, this attribute must be named `can_be_type`. However, you can have the attribute be named anything that you would like, you just need to tell CanBe what it is. Indexing this column is your choice. @@ -43,11 +43,11 @@ add_index :addresses, :can_be_type end end ``` -**NOTE:** Examples of the database migrations can be found in the [`spec/support/schema.rb`](https://github.com/mstarkman/can_be/blob/master/spec/support/schema.rb) file. +**NOTE:** Examples of the database migrations can be found in the [`spec/support/schema.rb`](spec/support/schema.rb) file. ## Model Configuration To add CanBe to your model, you simply need to call the `can_be` method on your model. @@ -80,11 +80,11 @@ default_type :female end end ``` -**NOTE:** Examples of the model configurations can be found in the [`spec/support/models.rb`](https://github.com/mstarkman/can_be/blob/master/spec/support/models.rb) file. +**NOTE:** Examples of the model configurations can be found in the [`spec/support/models.rb`](spec/support/models.rb) file. ## Usage The CanBe gem will provide you a lot methods to handle your type processing in an easy and consistent manner. @@ -132,6 +132,6 @@ 4. Push to the branch (`git push origin my-new-feature`) 5. Create new Pull Request ## License -See [LICENSE.txt](https://github.com/mstarkman/can_be/blob/master/LICENSE.txt). +See [LICENSE.txt](LICENSE.txt).