README.markdown in remi-aux_codes-1.0.5 vs README.markdown in remi-aux_codes-1.0.6
- old
+ new
@@ -78,26 +78,18 @@
Breed['Golden Retriever']
Breed[:golden_retriever]
Breed.golden_retriever
AuxCodes.breeds.golden_retriever
+Read [the spec](http://github.com/remi/aux_codes/blob/master/spec/aux_code_spec.rb) to see other usage examples
+
TODO
----
- make a spec specifically for showing off the different API features quickly and easily
- convert this README to RDoc
- - custom fields, eg:
- - `Breed#acronym`
- - `Breed#description`
- - `Breed#kennel_association_id` ...
- - these need an easy way to be defined! `alias_attribute`?
- - this needs to work in development mode, when the models are constantly being reloaded!
- - you shouldn't have to know the name of the special field to use it ... something like `attr_string :name` could just grab the (first) string column!
- - should we have a field for misc serialized meta-data? could be abused ... but could also be helpful ...
- - create (or update) method(s) for helping with the original AuxCode migration and for creating the special additional fields
- make table name and column names configurable (but with strong defaults)
- - should have a rails generator ... should be 1 command to setup `aux_codes` in Rails
- - after i add a rails generator, i'll bump to 1.1.0 and release
+ - staticly typed fields?
NOTES
-----
this implementation is for ActiveRecord only! i hope to eventually make a similar DataMapper implementation