README.md in provider_taxonomy-0.1.0 vs README.md in provider_taxonomy-0.1.1
- old
+ new
@@ -1,11 +1,8 @@
-# ProviderTaxonomy
+# Provider Taxonomy
A gem to add a database table containing the NUCC Health Care Provider Taxonomy.
-## Usage
-Once installed, your Rails app will have a TaxonomyItem database table, from which you can access all healthcare provider specialties.
-
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'provider_taxonomy'
@@ -20,9 +17,22 @@
```bash
$ rake db:migrate
```
```bash
$ rake provider_taxonomy:import
+```
+
+## Usage
+Once installed, your Rails app will have a `taxonomy_items` database table and a `TaxonomyItem` model from which you can access all healthcare provider specialties.
+
+If you would like to extend the model with your own, you can do the following
+
+```ruby
+class Specialty < ActiveRecord::Base
+ self.table_name = "taxonomy_items"
+ belongs_to :parent, foreign_key: :parent_id, class_name: Specialty, required: false
+ # Your code goes here
+end
```
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).