Skip to content

Commit

Permalink
add readme (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
c-eg authored Aug 11, 2024
1 parent 43ea721 commit 527e228
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit 527e228

Please sign in to comment.