README.md in phobos_db_checkpoint-1.1.0 vs README.md in phobos_db_checkpoint-2.0.0.rc1
- old
+ new
@@ -16,10 +16,11 @@
1. [Handler](#handler)
1. [Failures](#failures)
1. [Accessing the events](#accessing-the-events)
1. [Events API](#events-api)
1. [Instrumentation](#instrumentation)
+1. [Upgrading](#upgrading)
1. [Development](#development)
## <a name="installation"></a> Installation
Add this line to your application's Gemfile:
@@ -292,9 +293,33 @@
* key
* partition
* offset
* retry_count
* checksum
+
+## <a name="upgrading"></a> Upgrading
+
+#### From <2.0 to 2.x
+
+##### Rename database tables
+
+The database table names for Event and Failure has been changed to be namespaced under `phobos_db_checkpoint_` to avoid potential collisions with projects that already have these names.
+
+This means that when upgrading one would have to add a new migration to rename from old name to new:
+
+```ruby
+def up
+ rename_table :events, :phobos_db_checkpoint_events
+ rename_table :failures, :phobos_db_checkpoint_failures
+end
+```
+
+Alternatively, one could potentially configure the tables to use the old names, as such:
+
+```ruby
+PhobosDBCheckpoint::Event.table_name = :events
+PhobosDBCheckpoint::Failure.table_name = :failures
+```
## <a name="development"></a> Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec spec` to run the tests.