--- /dev/null
+= Composite Primary Keys for ActiveRecords\r
+\r
+== Summary\r
+\r
+ActiveRecords/Rails famously doesn't support composite primary keys. \r
+This RubyGem extends the activerecord gem to provide CPK support.\r
+\r
+== Installation\r
+\r
+ gem install composite_primary_keys\r
+ \r
+== Usage\r
+ \r
+ require 'composite_primary_keys'\r
+ class ProductVariation\r
+ set_primary_keys :product_id, :variation_seq\r
+ end\r
+ \r
+ pv = ProductVariation.find(345, 12)\r
+ \r
+It even supports composite foreign keys for associations.\r
+\r
+See http://compositekeys.rubyforge.org for more.\r
+\r
+== Running Tests\r
+\r
+See test/README.tests.txt\r
+\r
+== Url\r
+\r
+http://compositekeys.rubyforge.org\r
+\r
+== Questions, Discussion and Contributions\r
+\r
+http://groups.google.com/compositekeys\r
+\r
+== Author\r
+\r
+Written by Dr Nic Williams, drnicwilliams@gmail\r
+Contributions by many!\r
+\r