Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

README updates.

  • Loading branch information...
commit 00e1f8263cf30fda868b4b24659e28a02622f9d5 1 parent 0189b4a
@robwilkerson robwilkerson authored
Showing with 7 additions and 7 deletions.
  1. +7 −7 README.md
View
14 README.md
@@ -6,13 +6,13 @@ The behavior tracks changes on two levels. It takes a snapshot of the fully hydr
## Features
+* Support for CakePHP 2.0. Thanks, @jasonsnider.
* Tracks object snapshots as well as individual property changes.
* Allows each revision record to be attached to a source -- usually a user -- of responsibility for the change.
* Allows developers to ignore changes to specified properties. Properties named `created`, `updated` and `modified` are ignored by default, but these values can be overwritten.
* Handles changes to HABTM associations.
* Fully compatible with the [`PolymorphicBehavior`](http://bakery.cakephp.org/articles/view/polymorphic-behavior).
* Does not require or rely on the existence of explicit models revisions (`AuditLog`) and deltas (`AuditLogDeltas`).
-* CakePHP >= 2.0
## Installation
@@ -25,7 +25,7 @@ The behavior tracks changes on two levels. It takes a snapshot of the fully hydr
#### As a Submodule
-1. `$ git submodule add git://github.com/jasonsnider/CakePHP-Audit-Log-Plugin.git <path_to>/app/Plugin/AuditLog`
+1. `$ git submodule add git://github.com/robwilkerson/CakePHP-Audit-Log-Plugin.git <path_to>/app/Plugin/AuditLog`
1. `$ git submodule init`
1. `$ git submodule update`
@@ -35,6 +35,10 @@ To create tables you can use schema shell. To create tables execute:
chmod +x ./Console/cake
./Console/cake schema create --plugin AuditLog --name AuditLog
+### CakePHP 1.3.x
+
+For use with CakePHP 1.3.x, be sure to use code from the `1.3` branch and follow the instructions in that README file.
+
### Next Steps
1. Run the `install.sql` file on your CakePHP application database. This will create the `audits` and `audit_deltas` tables that will store each object's relevant change history.
@@ -98,16 +102,12 @@ Applying the `AuditableBehavior` to a model is essentially the same as applying
## Limitations
-* This is not backwards compatible with CakePHP <=1.3. If you need compatibility with these version please visit [the original project](http://github.com/robwilkerson/CakePHP-Audit-Log-Plugin).
+* The master branch is not backwards compatible with CakePHP <=1.3.x. If you need compatibility with these version please install the code from the `1.3` branch and follow the instructions in that README.
## License
This code is licensed under the [MIT license](http://www.opensource.org/licenses/mit-license.php).
-## Credits
-This is a fork of [Rob Wilkerson's AuditLog Plugin](http://github.com/robwilkerson/CakePHP-Audit-Log-Plugin).
-This version has been updated for compatibility with CakePHP 2.0 and hopefully :) better cross DBMS support.
-
## Notes
Feel free to submit bug reports or suggest improvements in a ticket or fork this project and improve upon it yourself. Contributions welcome.
Please sign in to comment.
Something went wrong with that request. Please try again.