Add a development section for contributors

This should make it easier for people to set up the library and run the test suite within Docker
DatabaseCleaner · Jul 12, 2024 · c466166 · c466166
1 parent 8c6d5da
commit c466166
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -100,6 +100,18 @@ test:
   min_messages: WARNING
 </pre>
 
+## Development
+
+If you want to test this library locally, you can do so like this:
+
+```
+docker compose run --build --rm ruby /bin/bash
+bundle
+bundle exec rake
+```
+
+You will need Docker installed. The configuration is set up for the latest Ruby, Rails, Postgres, and MySQL versions.
+
 ## COPYRIGHT
 
 See [LICENSE](LICENSE) for details.