Skip to content

Commit f6e700c

Browse files
author
Jove Zhong
committed
Update README.md
1 parent aa9aab1 commit f6e700c

File tree

1 file changed

+26
-24
lines changed

1 file changed

+26
-24
lines changed

README.md

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,36 @@
22
[//]: # (SPDX-License-Identifier: Apache-2.0)
33
[//]: # (---)
44

5-
# Rust Client for Proton SQL Streaming Engine
6-
7-
Rust client for [Proton / TimePlus]([url](https://www.timeplus.com/)https://www.timeplus.com/).
5+
# Rust Client for Proton
6+
7+
Rust client for [Timeplus Proton](https://github.com/timeplus-io/proton).
88

99
Proton is a streaming SQL engine, a fast and lightweight alternative to Apache Flink, 🚀 powered by ClickHouse. It enables developers to solve streaming data processing, routing and analytics challenges from Apache Kafka, Redpanda and more sources, and send aggregated data to the downstream systems. Proton is the core engine of [Timeplus](https://timeplus.com), which is a cloud native streaming analytics platform.
1010

11+
The initial version(0.1.0) of the client was written by [Marvin Hansen](https://github.com/marvin-hansen). Thanks for the contribution.
1112

12-
## Install proton
13+
## Install Proton
1314

14-
```
15-
brew install proton
16-
```
15+
### As a single binary
16+
17+
On Linux or Mac, you can install it via `curl https://install.timeplus.com | sh`
18+
19+
On Mac, you can also install it via `brew install proton`
20+
21+
After you get the `proton` binary, you can start the Proton server via `proton server start`
1722

18-
1. Start the Proton server:
19-
$ proton server start
23+
In a separate terminal, connect to the server via `proton client` (Note: If you encounter a 'connection refused' error, use: proton client --host 127.0.0.1)
2024

21-
2. In a separate terminal, connect to the server:
22-
$ proton client
23-
(Note: If you encounter a 'connection refused' error, use: proton client --host 127.0.0.1)
25+
### As a Docker container
26+
27+
```bash
28+
docker run -d --pull always --name proton ghcr.io/timeplus-io/proton:latest
29+
```
30+
31+
Proton is automatically started. Open the terminal of the container, and run `proton client`
2432

25-
3. To terminate the server, press ctrl+c in the server terminal.
2633

27-
For detailed usage and more information, check out the Timeplus documentation:
28-
https://docs.timeplus.com/
34+
For detailed usage and more information, check out the documentation: https://docs.timeplus.com/proton
2935

3036

3137
## Install ProtonClient
@@ -34,7 +40,7 @@ Add the following to your Cargo.toml:
3440

3541
```
3642
[dependencies]
37-
proton_client = { git = "https://github.com/marvin-hansen/proton-rust-client.git" }
43+
proton_client = { git = "https://github.com/timeplus-io/proton-rust-client.git" }
3844
```
3945

4046
[//]: # (AFTER the release of the package on crates.io)
@@ -87,29 +93,25 @@ async fn main() -> Result<()> {
8793

8894
## What's next?
8995

90-
To see more examples of using Proton, check out the [examples](examples) folder.
96+
To see more examples of using Proton, check out the [examples](https://github.com/timeplus-io/proton/tree/develop/examples) folder in Proton repo.
9197

92-
Check out the proton [documentation on the SQL Query syntax](https://docs.timeplus.com/query-syntax).
98+
Please note, by default the SQL queries are in streaming mode. Learn more about SQL syntax at [Proton Documentation](https://docs.timeplus.com/query-syntax).
9399

94100

95101
## Documentation
96102

97103
You find the full documentation for Proton at [docs.timeplus.com](https://docs.timeplus.com/proton) alongside documentation for the Timeplus (Cloud and BYOC) platform.
98104

99-
We also have a [FAQ](https://docs.timeplus.com/proton-faq/) for detailing how we chose Apache License 2.0, how Proton is related to ClickHouse, what features are available in Proton versus Timeplus, and more.
100-
101-
102105
## Contributing
103106

104-
We welcome your contributions! If you are looking for issues to work on, try looking at [the issue list](FIXLINK).
107+
We welcome your contributions!
105108

106109
## Need help?
107110

108111
Join our [Timeplus Community Slack](https://timeplus.com/slack) to connect with Timeplus engineers and other Proton users.
109112

110-
For filing bugs, suggesting improvements, or requesting new features, see the [open issues](FIXLINK) here on GitHub.
113+
For filing bugs, suggesting improvements, or requesting new features, see the [open issues](https://github.com/timeplus-io/proton-rust-client/issues) here on GitHub.
111114

112115
## Licensing
113116

114117
Proton Rust Client uses Apache License 2.0. See details in the [LICENSE](LICENSE).
115-

0 commit comments

Comments
 (0)