From aaa2215a9c9931bf24fb6735e807b0672011a659 Mon Sep 17 00:00:00 2001
From: Navan Chauhan <navanchauhan@gmail.com>
Date: Wed, 24 Apr 2024 02:05:03 -0600
Subject: add readme

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

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)")
+    }
+}
+```
+
-- 
cgit v1.2.3