Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Readme #337

Merged
merged 1 commit into from
Dec 6, 2024
+6 −2
Merged

Improve Readme #337

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,7 @@ the `:validity` option:
change_table :your_table, temporal: true, copy_data: true, validity: '1977-01-01'
```

Please note that `change_table` requires you to use *old_style* `up` and
`down` migrations. It cannot work with Rails 3-style `change` migrations.
Please note that `change_table` requires you to use `up` and `down` migrations.


## Selective Journaling
Expand Down Expand Up @@ -361,6 +360,10 @@ Ensure to run the full test suite before pushing.

* `*_by_sql` query methods are not supported. [See issue #313][gh-issue-313]

* `self.table_name` must be set before `include ChronoModel::TimeMachine`.
[See issue #336][gh-issue-336]


## Contributing

1. Fork it
Expand Down Expand Up @@ -428,3 +431,4 @@ This software is Made in Italy :it: :smile:.
[gh-issue-192]: https://github.com/ifad/chronomodel/issues/192
[gh-issue-206]: https://github.com/ifad/chronomodel/issues/206
[gh-issue-313]: https://github.com/ifad/chronomodel/issues/313
[gh-issue-336]: https://github.com/ifad/chronomodel/issues/336
Loading