diff --git a/Cargo.toml b/Cargo.toml index 89dbdd7..d9bd0fb 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,8 +1,16 @@ [package] name = "servicepoint-cli" +description = "A command line interface for the ServicePoint display." version = "0.1.0" edition = "2021" rust-version = "1.78.0" +publish = true +resolver = "2" +readme = "README.md" +license = "GPL-3.0-or-later" +repository = "https://git.berlin.ccc.de/servicepoint/servicepoint-cli" +homepage = "https://crates.io/crates/servicepoint-cli" +keywords = ["cccb", "cccb-servicepoint", "cli"] [dependencies] servicepoint = { version = "0.13.0", features = ["protocol_websocket"] } diff --git a/README.md b/README.md index 814eaec..f16d4ab 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,15 @@ This repository contains a command line interface for the ServicePoint display. To send commands, this uses the [servicepoint crate](https://crates.io/crates/servicepoint). -## Running +## Installation with cargo -Any OS: ```shell -git clone https://git.berlin.ccc.de/servicepoint/servicepoint-cli.git -cd servicepoint-cli -cargo run -- +cargo install servicepoint-cli ``` -Using nix: +If you have set your PATH to include the ~/.cargo/bin, you can now run `servicepoint-cli`. + +## Running with nix ```shell # from CCCB Forgejo @@ -23,6 +22,15 @@ nix run git+https://git.berlin.ccc.de/servicepoint/servicepoint-cli.git -- ``` + +## Running a debug build + +```shell +git clone https://git.berlin.ccc.de/servicepoint/servicepoint-cli.git +cd servicepoint-cli +cargo run -- +``` + ## Contributing If you have ideas on how to improve the code, add features or improve documentation feel free to open a pull request.