From eea31b359cf392df7adaf93cb271999b9a0cbca5 Mon Sep 17 00:00:00 2001
From: gram <git@orsinium.dev>
Date: Sun, 8 Dec 2024 10:02:03 +0100
Subject: [PATCH] license, readme

---
 LICENSE   | 21 +++++++++++++++++++++
 README.md | 18 ++++++++++++++++++
 2 files changed, 39 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d67b0e4
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 @orsinium
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bba90f8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# pgxtester
+
+A Go package for testing code that uses PostgreSQL. It establishes a concurrency-safe [pgx](https://github.com/jackc/pgx) connection, wraps it into a transaction, and rolls back the transaction at the end of the test. This ensures that changes done in a test will not affect other tests.
+
+## Installation
+
+```bash
+go get github.com/orsinium-labs/pgxtester
+```
+
+## Usage
+
+```go
+func SomeTest(t *testing.T) {
+    conn := pgxtester.Connect(t, pgxtester.Config{URL: "..."})
+    // ...
+}
+```