diff --git a/README.md b/README.md index 9f306af1..f16f92d2 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,8 @@ Simple Builders generates fluent, type-safe builders for your **existing** class - **Immutables / Google AutoValue / FreeBuilder** — value-type generators: you declare an abstract class or interface and they generate an immutable implementation plus a builder. Great when you want to define new immutable value types; less suited when you just want a builder for classes or records you already have and don't want to restructure your model. - **RecordBuilder** — focused, excellent builders and `with` methods for records. Choose it if you use records exclusively. +What none of them cover: [`@SimpleBuilderFor`](docs/CONFIGURATION.md#generating-builders-for-external-types) generates builders for types you cannot annotate — third-party classes, generated code, shared libraries — and [`packageName`](docs/CONFIGURATION.md#packagename) places the generated builders in a package of your choice. + Use Simple Builders when you want fluent, type-safe builders for the classes and records you already have, generated as plain readable source, with no bytecode manipulation and no IDE plugin — and no lock-in: because the builders are ordinary generated Java, you can drop the dependency at any time by copying the generated builder classes into your own sources, and they keep working. For performance benchmark results comparing Simple Builders, Simple Minimal Builder, RecordBuilder, and Lombok, see the [Performance Analysis Guide](performance-test/docs/PERFORMANCE_ANALYSIS.md#benchmark-results).