From 084aa25047d44b91b08dc686efd8f7dd693a41e5 Mon Sep 17 00:00:00 2001 From: Gabriel Kaszewski Date: Fri, 29 May 2026 02:09:35 +0000 Subject: [PATCH] wiki: add Installation page --- Installation.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 Installation.md diff --git a/Installation.md b/Installation.md new file mode 100644 index 0000000..c21b464 --- /dev/null +++ b/Installation.md @@ -0,0 +1,48 @@ +# Installation + +k-ap is published to a private Gitea registry. Add it via the registry (recommended) or via git. + +--- + +## Via Gitea registry (recommended) + +Add to `Cargo.toml`: + +```toml +[dependencies] +k-ap = { version = "0.3.0", registry = "gitea" } +``` + +Add to `.cargo/config.toml` (create if it doesn't exist): + +```toml +[registries.gitea] +index = "sparse+https://git.gabrielkaszewski.dev/api/packages/GKaszewski/cargo/" +``` + +--- + +## Via git + +If you don't have registry access: + +```toml +[dependencies] +k-ap = { git = "https://git.gabrielkaszewski.dev/GKaszewski/k-ap.git", tag = "v0.3.0" } +``` + +--- + +## Requirements + +- Rust edition **2024** +- `tokio` runtime with `macros`, `net`, `rt`, `rt-multi-thread`, `sync`, and `time` features +- `axum` 0.8 — k-ap returns an `axum::Router` + +--- + +## Current version + +**0.3.0** + +See the [Migration Guide](Migration-Guide) if upgrading from 0.1.x. \ No newline at end of file