Skip to content

Latest commit

 

History

History
63 lines (38 loc) · 3 KB

README.md

File metadata and controls

63 lines (38 loc) · 3 KB
A katana leaning on a stand

Nakago (中子)

A lightweight async dependency injection toolkit for Rust

Crates.io Docs.rs CI Coverage Status

Rust Tokio Axum

Nakago is a toolkit for building Rust applications with a modular structure, taking advantage of dependency injection to bring organization and testability to Rust projects large and small.

⚠️ Alpha Disclaimer

NOTE: This library is in early development, and the API may shift rapidly as it evolves. Be advised that this is not yet recommended for Production use.

Features

As development progresses, components will be split up into separate crates, so that developers can install only what they need.

Installation

Cargo

  • Install Rust and Cargo by following this guide.
  • Run cargo install nakago, along with cargo install nakago-derive, cargo install nakago-axum, etc. for each feature you need.

Etymology

Nakago (中子) is a Japanese word meaning "core", or less commonly the "middle of a nest of boxes". It often refers to the tang of a Japanese katana - the foundation of the hilt and the mechanism through which a sword is wielded. The nakago must be sound and resilient, allowing the holder to guide the blade with confidence.

Development

See docs/development.md.

License

Licensed under the MIT license (LICENSE or http://opensource.org/licenses/MIT).

Contribution

See CONTRIBUTING.md.

Attribution

Katana image by fordevector at Vecteezy.