Skip to content

Commit

Permalink
Update README for Jetstream.
Browse files Browse the repository at this point in the history
  • Loading branch information
christiandeange committed Nov 24, 2024
1 parent 6270e94 commit ef5b0e2
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ ozone

### Overview

The Ozone project for the [AT Protocol](https://atproto.com/) consists of 3 components:
The Ozone project for the [AT Protocol](https://atproto.com/) consists of 4 components:

1. A Gradle plugin to compile AT Protocol schemas into usable Kotlin classes.
2. Multiplatform APIs for the AT Protocol spec that can be used with any compatible service, including [Bluesky Social](https://bsky.app).
- Supports Android, JVM, JavaScript, and iOS.
3. Example client apps that demonstrate usage of those APIs.
3. APIs to connect to the [Jetstream](https://github.com/bluesky-social/jetstream) firehose for Bluesky Social.
- Supports Android, JVM, and JavaScript.
4. Example client apps that demonstrate usage of those APIs.

> **Warning**
>
Expand Down Expand Up @@ -42,6 +44,20 @@ dependencies {

In Xcode, select **File > Add Packages** and enter https://github.com/christiandeange/BlueskyAPI

### Jetstream Bindings

Documentation is available at [ozone.christian.sh](https://ozone.christian.sh/ozone/sh.christian.ozone.jetstream/index.html).

#### Java / Kotlin

```kotlin
// build.gradle[.kts]

dependencies {
api("sh.christian.ozone:jetstream:0.2.0")
}
```

### Gradle Plugin

In addition to shipping the lexicons that define the official Bluesky API, this project also includes a Gradle Plugin that allows you to bring your own lexicon definitions and generate any set of AT Protocol bindings from them.
Expand Down

0 comments on commit ef5b0e2

Please sign in to comment.