add readme

1 files changed, 20 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..90032db
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Swift-Lichess
+
+API Client for Lichess. The end goal of this package is to implement everything listed in the OpenAPI Reference (2.0.0)
+
+## Example
+
+```swift
+import LichessClient
+
+let client = LichessClient()
+
+Task {
+    do {
+        let tournaments = try await client.broadcastIndex(nb: 10)
+    } catch {
+        print("Error fetching tournaments: \(error)")
+    }
+}
+```
+