Skip to content

Commit

Permalink
chore: Add README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Vaibhav Rabber <[email protected]>
  • Loading branch information
vrongmeal committed Dec 16, 2024
1 parent 947f5eb commit 9bbd8cf
Show file tree
Hide file tree
Showing 3 changed files with 69 additions and 1 deletion.
70 changes: 69 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,69 @@
# streamstore-cli
<div align="center">
<p>
<!-- Light mode logo -->
<a href="https://s2.dev#gh-light-mode-only">
<img src="./assets/s2-black.png" height="60">
</a>
<!-- Dark mode logo -->
<a href="https://s2.dev#gh-dark-mode-only">
<img src="./assets/s2-white.png" height="60">
</a>
</p>

<h1>S2 CLI</h1>

<p>
<!-- Crates.io -->
<a href="https://crates.io/crates/streamstore-cli"><img src="https://img.shields.io/crates/v/streamstore-cli.svg" /></a>
<!-- Github Actions (CI) -->
<a href="https://github.com/s2-streamstore/s2-cli/actions?query=branch%3Amain++"><img src="https://github.com/s2-streamstore/s2-cli/actions/workflows/ci.yml/badge.svg" /></a>
<!-- Discord (chat) -->
<a href="https://discord.gg/vTCs7kMkAf"><img src="https://img.shields.io/discord/1209937852528599092?logo=discord" /></a>
<!-- LICENSE -->
<a href="./LICENSE"><img src="https://img.shields.io/github/license/s2-streamstore/s2-cli" /></a>
</p>
</div>

Command Line Tool to interact with the [S2 API](https://buf.build/streamstore/s2/docs/main:s2.v1alpha).

## Installation

### Using Homebrew

This works on macOS and Linux distributions with [Homebrew](https://brew.sh)
installed.

```bash
brew install s2-streamstore/s2/s2
```

### Using Cargo

```bash
cargo install streamstore-cli
```

## Getting started

## Feedback

We use [Github Issues](https://github.com/s2-streamstore/s2-cli/issues) to
track feature requests and issues with the SDK. If you wish to provide feedback,
report a bug or request a feature, feel free to open a Github issue.

### Contributing

Developers are welcome to submit Pull Requests on the repository. If there is
no tracking issue for the bug or feature request corresponding to the PR, we
encourage you to open one for discussion before submitting the PR.

## Reach out to us

Join our [Discord](https://discord.gg/vTCs7kMkAf) server. We would love to hear
from you.

You can also email us at [[email protected]](mailto:[email protected]).

## License

This project is licensed under the [Apache-2.0 License](./LICENSE).
Binary file added assets/s2-black.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/s2-white.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9bbd8cf

Please sign in to comment.