document the benchmark scripts

Author: tompave

CHANGELOG.md

@@ -1,10 +1,11 @@
 # Changelog
 
-## v1.13.0
+## v1.13.0 (unreleased)
 
 * Add support for Elixir 1.18. Drop support for Elixir 1.15. Elixir >= 1.16 is now required. Dropping support for older versions of Elixir simply means that this package is no longer tested with them in CI, and that compatibility issues are not considered bugs.
 * Drop support for Erlang/OTP 24, and Erlang/OTP >= 25 is now required. Dropping support for older versions of Erlang/OTP simply means that this package is not tested with them in CI, and that no compatibility issues are considered bugs.
 * Improve how the change-notification Phoenix.PubSub adapter manages its connection and readiness status. ([pull/191](https://github.com/tompave/fun_with_flags/pull/191))
+* Adding a suite of synthetic benchmark scripts for the package. ([pull/193](https://github.com/tompave/fun_with_flags/pull/193))
 
 ## v1.12.0
 

README.md

@@ -46,6 +46,7 @@ It stores flag information in Redis or a relational DB (PostgreSQL, MySQL, or SQ
 * [Testing](#testing)
 * [Development](#development)
   - [Working with PubSub Locally](#working-with-pubsub-locally)
+  - [Benchmarks](#benchmarks)
 
 ## What's a Feature Flag?
 
@@ -839,3 +840,7 @@ Steps:
 5. In either terminal, run `Node.list()` to check that there is a connection.
 
 Done that, modifying any flag data in either terminal will notify the other one via PubSub.
+
+### Benchmarks
+
+The package comes with [a suite of synthetic benchmark scripts](https://github.com/tompave/fun_with_flags/tree/master/benchmarks). Their use is recommended when working on the internals of the package.

benchmarks/README.md

@@ -0,0 +1,9 @@
+# Benchmarks
+
+Some simple benchmark scripts for the package. Use them as they are or modify them to test specific scenarios.
+
+Example:
+
+```
+mix run benchmarks/flag.exs
+```