diff --git a/README.md b/README.md index ed18492..e2ef538 100644 --- a/README.md +++ b/README.md @@ -1 +1,69 @@ -# streamstore-cli +
+ +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 [hi@s2.dev](mailto:hi@s2.dev). + +## License + +This project is licensed under the [Apache-2.0 License](./LICENSE). diff --git a/assets/s2-black.png b/assets/s2-black.png new file mode 100644 index 0000000..322d1b5 Binary files /dev/null and b/assets/s2-black.png differ diff --git a/assets/s2-white.png b/assets/s2-white.png new file mode 100644 index 0000000..438037e Binary files /dev/null and b/assets/s2-white.png differ