diff --git a/README.md b/README.md index 3512a0fe..afca3276 100644 --- a/README.md +++ b/README.md @@ -352,7 +352,23 @@ object NginxContainer { ### Migration from the classic API -TODO +1. If you have custom containers created with the `GenericContainer`, add `ContainerDef` in the companion like this: + ```scala + object MyCustomContainer { + case class Def(/*constructor params here*/) extends GenericContainer.Def[MyCustomContainer]( + new MyCustomContainer(/*constructor params here*/) + ) + } + ``` +2. If you are using `ForEachTestContainer`: + 1. If your test contains only one container, replace `ForEachTestContainer` with `TestContainerForEach` + 2. If your test contains multiple containers, replace `ForEachTestContainer` with `TestContainersForEach` +3. If you are using `ForAllTestContainer`: + 1. If your test contains only one container, replace `ForAllTestContainer` with `TestContainerForAll` + 2. If your test contains multiple containers, replace `ForAllTestContainer` with `TestContainersForAll` +4. Fix all compilation errors using compiler messages and examples above. + +If you have any questions or difficulties feel free to ask it in our [slack channel](https://testcontainers.slack.com/messages/CAFK4GL85). ## Release notes