README.md in mcfly-0.0.2 vs README.md in mcfly-0.0.3
- old
+ new
@@ -1,10 +1,10 @@
# Mcfly
Mcfly is a database table versioning system. It's useful for tracking
and auditing changes to database tables. It's also very easy to
-access the current state of Mcfly tables at any point in time.
+access the state of Mcfly tables at any point in its history.

## Features
@@ -48,20 +48,19 @@
create_table :market_prices do |t|
t.references :security_instrument, null: false
t.decimal :coupon, null: false
t.integer :settlement_mm, null: false
t.integer :settlement_yy, null: false
- # NULL indicates unknown price
t.decimal :price
end
end
end
-These migration add the necessary versioning triggers for INSERT,
+These migrations add the necessary versioning triggers for INSERT,
UPDATE and DELETE operations. The append-only migration disallows
-updates. As such, append-only Mcfly tables rows to be INSERTed or
-DELETEed, but not modified.
+updates. As such, append-only Mcfly tables allow rows to be INSERTed
+or DELETEed, but not modified.
When you declare `has_mcfly` in your model, Mcfly adds some basic
functionality to the class.
class SecurityInstrument < ActiveRecord::Base
@@ -79,16 +78,13 @@
mcfly_lookup :lookup_all, sig: 1 do
|pt| all
end
end
-The `has_mcfly` declaration provides the `mcfly_lookup` generator
-which is scopes queries to the proper timeline. Also,
-`mcfly_validates_uniqueness_of` is Mcfly's scoped version of
-ActiveRecord's `validates_uniqueness_of`.
+The `has_mcfly` declaration provides the `mcfly_lookup` generator which scopes queries to the proper timeline. Also, `mcfly_validates_uniqueness_of` is Mcfly's scoped version of ActiveRecord's `validates_uniqueness_of`.
-... TODO ... show examples of adding rows and accessing versions of
-data ...
+## Setting/Finding Responsible Party For A Change
+TODO: discuss using `current_user` method in `ApplicationController`. Also, setting `Mcfly.whodunnit`.
## Implementation
TODO