Skip to content

Commit dc7657f

Browse files
authored
docs: add crate metadata and link the Hotdata CLI (#39)
1 parent 98efe93 commit dc7657f

2 files changed

Lines changed: 7 additions & 1 deletion

File tree

Cargo.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ authors = ["developers@hotdata.dev"]
55
description = "Powerful data platform API for datasets, queries, and analytics."
66
license = "MIT"
77
edition = "2021"
8+
readme = "README.md"
9+
repository = "https://github.com/hotdata-dev/sdk-rust"
10+
homepage = "https://www.hotdata.dev"
11+
documentation = "https://docs.rs/hotdata"
12+
keywords = ["hotdata", "sdk", "api-client", "arrow", "async"]
13+
categories = ["api-bindings", "asynchronous", "database"]
814

915
[dependencies]
1016
serde = { version = "^1.0", features = ["derive"] }

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ hotdata = { version = "0.1", default-features = false, features = ["rustls"] }
3636

3737
The API authenticates with an **API token** sent as `Authorization: Bearer <token>`, plus an **`X-Workspace-Id`** header on requests scoped to a workspace.
3838

39-
API tokens (prefixed `hd_`) are exchanged transparently for short-lived JWTs the first time a request is made, and the JWT is cached and refreshed automatically. You only ever supply the API token — the `Client` does the exchange against `/v1/auth/jwt` for you, mirroring the Hotdata CLI.
39+
API tokens (prefixed `hd_`) are exchanged transparently for short-lived JWTs the first time a request is made, and the JWT is cached and refreshed automatically. You only ever supply the API token — the `Client` does the exchange against `/v1/auth/jwt` for you, mirroring the [Hotdata CLI](https://github.com/hotdata-dev/hotdata-cli).
4040

4141
If you already hold a JWT (a value beginning with `eyJ`), it is passed through unchanged with no exchange. To disable the exchange entirely, set `HOTDATA_DISABLE_JWT_EXCHANGE` to `1`, `true`, `yes`, or `on`.
4242

0 commit comments

Comments
 (0)