further clean up markdown files, refine Cargo.toml

Author: Jove Zhong

Cargo.toml

@@ -6,12 +6,12 @@ rust-version = "1.65"
 readme = "README.md"
 license = "Apache-2.0"
 
-authors = ["Marvin Hansen <marvin.hansen@gmail.com>", ]
-description = "Client for the Proton / TimePlus SQL streaming engine"
+authors = ["Marvin Hansen <marvin.hansen@gmail.com>"]
+description = "Client for Timeplus Proton, a streaming SQL engine"
 documentation = "https://docs.rs/proton_client"
 homepage = "https://github.com/timeplus-io/proton-rust-client"
 repository = "https://github.com/timeplus-io/proton-rust-client"
-keywords = ["proton", "timeplus", "streaming", "database", "timeseries"]
+keywords = ["proton", "timeplus", "streaming", "sql", "database", "timeseries"]
 
 [lib]
 name = "proton_client"
@@ -35,10 +35,10 @@ path = "examples/remove/main.rs"
 
 [dependencies]
 clickhouse = { version = "0.11", features = ["watch"] }
-clickhouse-derive = { version = "0.1"}
+clickhouse-derive = { version = "0.1" }
 tokio = { version = "1", features = ["rt-multi-thread", "macros"] }
 serde = { version = "1.0.196", features = ["derive"] }
 
 
 [dev-dependencies]
-clickhouse = { version = "0.11", features = ["test-util"] }
+clickhouse = { version = "0.11", features = ["test-util"] }

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2016-2022 ClickHouse, Inc.
+   Copyright 2021-2024 Timeplus, Inc.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -10,6 +10,8 @@ Proton is a streaming SQL engine, a fast and lightweight alternative to Apache F
 
 The initial version(0.1.0) of the client was written by [Marvin Hansen](https://github.com/marvin-hansen). Thanks for the contribution.
 
+This client uses https://crates.io/crates/clickhouse as a dependency.
+
 ## Install Proton
 
 ### As a single binary

SECURITY.md

@@ -1,25 +1,30 @@
 
 
-#  Examples for Rust Client for Proton 
- 
+#  Examples for Rust Client for Proton
 
-## Install proton
 
-```
-brew install proton
-```
+## Install Proton
+
+### As a single binary
+
+On Linux or Mac, you can install it via `curl https://install.timeplus.com | sh`
+
+On Mac, you can also install it via `brew install proton`
 
-1. Start the Proton server:
-   $ proton server start
+After you get the `proton` binary, you can start the Proton server via `proton server start`
 
-2. In a separate terminal, connect to the server:
-   $ proton client
-   (Note: If you encounter a 'connection refused' error, use: proton client --host 127.0.0.1)
+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)
 
-3. To terminate the server, press ctrl+c in the server terminal.
+### As a Docker container
+
+```bash
+docker run -d --pull always --name proton ghcr.io/timeplus-io/proton:latest
+```
+
+Proton is automatically started. Open the terminal of the container, and run `proton client`
 
-   For detailed usage and more information, check out the Timeplus documentation:
-   https://docs.timeplus.com/
+
+For detailed usage and more information, check out the documentation: https://docs.timeplus.com/proton
 
 
 ## Install ProtonClient
@@ -123,4 +128,3 @@ Expected output
 [prepare]: Delete Stream
 [prepare]: Stop
 ```
-