Merge pull request #36 from upfluence/xp/README

[ENG-1528] Add README
upfluence · Mar 6, 2024 · 11418cf · 11418cf
2 parents 13e6169 + 1f604a6
commit 11418cf
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+# SQL
+
+This repository provides packages to facilitate the handling of SQL databases.
+
+### `sql`
+
+Abstract the database and various nullable types.
+
+### `sql/x/sqlbuilder`
+
+A query builder, also used to declare columns.
+
+### `sql/x/migration`
+
+As the name implies, it applies migrations to a SQL database.
+
+### `sql/sqltest`
+
+Allows to query a database in a test environment (with logging and in-memory SQLite database).