Skip to content

Commit b8dcd1d

Browse files
committed
chore: update README
1 parent 009b9d1 commit b8dcd1d

1 file changed

Lines changed: 20 additions & 12 deletions

File tree

README.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -180,17 +180,18 @@ name: my_query
180180
SELECT 42
181181
```
182182

183-
Notes:
184-
- Queries can include named parameters (:param_name) or positional parameters ($1, $2).
185-
- Semicolons inside strings or comments are ignored; only the semicolon terminating a query ends the block.
186-
- The query handling is available as a separate [queries](http://github.com/boringSQL/queries) library.
183+
Notes:
184+
- Queries can include named parameters (:param_name) or positional
185+
parameters ($1, $2).
186+
- Semicolons inside strings or comments are ignored; only the semicolon
187+
terminating a query ends the block.
188+
- The query handling is available as a separate
189+
[queries](http://github.com/boringSQL/queries) library.
187190

188191
## Snapshots
189192

190-
Snapshots capture database state for reproducible regression testing. Instead of
191-
applying fixtures before each test run, you build a snapshot once and restore it
192-
before testing. This ensures tests always start from a known state, making them
193-
isolated and idempotent.
193+
Snapshots capture database state for reproducible regression testing. Build a
194+
snapshot from schema + migrations + fixtures, then restore it before testing.
194195

195196
**NOTICE**: Snapshot functionality is work in progress.
196197

@@ -299,7 +300,8 @@ generate:
299300

300301
## Ignoring Files
301302

302-
You can exclude SQL files from discovery using a `.regresignore` file in your project root:
303+
You can exclude SQL files from discovery using a `.regresignore` file in your
304+
project root:
303305

304306
```
305307
# Comments start with #
@@ -530,10 +532,16 @@ regresql/
530532

531533
## History
532534

533-
The project is a fork of original `regresql` written by [Dimitri Fontaine](https://github.com/dimitri) as part his book [Mastering PostgreSQL](http://masteringpostgresql.com/). The tool was originally inspired by PostgreSQL’s own regression testing framework, providing a lightweight and SQL-native approach to unit and regression testing.
535+
The project is a fork of original `regresql` written by [Dimitri
536+
Fontaine](https://github.com/dimitri) as part his book [Mastering
537+
PostgreSQL](http://masteringpostgresql.com/). The tool was originally inspired
538+
by PostgreSQL’s own regression testing framework, providing a lightweight and
539+
SQL-native approach to unit and regression testing.
534540

535-
The fork’s goal is to extend RegreSQL into a modern, extensible framework that supports the broader [boringSQL](https://boringsql.com) vision - helping developers to feel more confident working with SQL queries.
541+
The fork’s goal is to extend RegreSQL into a modern, extensible framework that
542+
supports the broader [boringSQL](https://boringsql.com) vision - helping
543+
developers to feel more confident working with SQL queries.
536544

537545
## License
538546

539-
The RegreSQL utility is released under [The PostgreSQL License](https://www.postgresql.org/about/licence/).
547+
The RegreSQL utility is released under [BSD-2-Clause license](LICENSE).

0 commit comments

Comments
 (0)