From 527e228dce708db27595963b19615400a83fd4ba Mon Sep 17 00:00:00 2001
From: Conor Egan <68134729+c-eg@users.noreply.github.com>
Date: Sun, 11 Aug 2024 01:44:54 +0100
Subject: [PATCH] add readme (#8)

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3d13eb9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Watch2Gether API
+![GitHub License](https://img.shields.io/github/license/c-eg/watch2getherapi)
+
+This library provides a Java-wrapper around the [JSON API](https://community.w2g.tv/t/watch2gether-api-documentation/133767) provided by
+[Watch2Gether](https://w2g.tv/), which is a service to watch videos online with others.
+
+## Usage
+To register for a Watch2Gether API key, click Tools / API from within your [profile page](https://w2g.tv/en/account/edit_user/).
+
+With this you can instantiate `uk.co.conoregan.watch2getherapi.Watch2GetherApi`, which contains all the methods for making requests to the Watch2Gether API.
+```java
+Watch2GetherApi api = new Watch2GetherApi("<apikey>");
+```
+
+## Project Logging
+This project uses [SLF4J](http://www.slf4j.org) to abstract the logging in the project. To use the logging in your own
+project you should add one of the provided [adapter bindings](http://www.slf4j.org/manual.html).