Skip to content

Commit

Permalink
chore: Update readme, release-plz config
Browse files Browse the repository at this point in the history
  • Loading branch information
sugyan committed May 7, 2023
1 parent 148b2a1 commit 3044a46
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 6 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/release-plz.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ jobs:
uses: dtolnay/rust-toolchain@stable
- name: Run release-plz
uses: MarcoIeni/[email protected]
with:
command: release-pr
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,21 @@ ATrium is divided into several sub-projects to address different aspects of the
### [`atrium-api`](./atrium-api/)

[![](https://img.shields.io/crates/v/atrium-api)](https://crates.io/crates/atrium-api)
[![](https://img.shields.io/docsrs/atrium-api)](https://docs.rs/atrium-api)

A library consisting of models and messaging definitions for XRPC, primarily generated using the codegen library
A library consisting of models and messaging definitions for XRPC, primarily generated using the codegen library.

### [`atrium-lex`](./atrium-lex/)

A library that provides type definitions for parsing the AT Protocol's [Lexicon](https://atproto.com/guides/lexicon) schema, ensuring compatibility with the lexicon
A library that provides type definitions for parsing the AT Protocol's [Lexicon](https://atproto.com/guides/lexicon) schema, ensuring compatibility with the lexicon.

### [`atrium-codegen`](./atrium-codegen/)

A library that generates Rust code for the `atrium-api` based on the analyzed lexicon definitions
A library that generates Rust code for the `atrium-api` based on the analyzed lexicon definitions.

### [`atrium-xrpc`](./atrium-xrpc/)

A client library that offers a convenient way to interact with the `atrium-api` and utilize its features
A client library that offers a convenient way to interact with the `atrium-api` and utilize its features.

### [`atrium-cli`](./atrium-cli/)

Expand All @@ -45,3 +46,12 @@ We welcome contributions from the community to help us improve and expand ATrium
## License

ATrium is released under the [MIT License](./LICENSE).

## Related works

Below are some related projects that might be of interest:

- `atproto` https://github.com/bluesky-social/atproto
- The leading protocol implementation
- `adenosine` https://gitlab.com/bnewbold/adenosine
- `atproto-rs` https://github.com/ngerakines/atproto-rs
1 change: 1 addition & 0 deletions release-plz.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ changelog_update = false

[[package]]
name = "atrium-api"
publish = true
changelog_update = true

[[package]]
Expand Down

0 comments on commit 3044a46

Please sign in to comment.