Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "xtax"
version = "0.1.0"
version = "0.1.1"
edition.workspace = true
rust-version.workspace = true
license.workspace = true
Expand Down Expand Up @@ -30,7 +30,7 @@ encryption = ["dep:xtax-encryption"]
full = ["blob-storage-full", "encryption"]

[dependencies]
xtax-blob-storage = { version = "0.1.0", path = "crates/xtax-blob-storage", optional = true, default-features = false }
xtax-blob-storage = { version = "0.1.1", path = "crates/xtax-blob-storage", optional = true, default-features = false }
xtax-encryption = { version = "0.1.0", path = "crates/xtax-encryption", optional = true }

[workspace]
Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[![Dependabot](https://img.shields.io/badge/dependabot-active-blue?logo=dependabot)](https://github.com/cz-jcode/xtax/network/updates)
[![crates.io](https://img.shields.io/crates/v/xtax.svg)](https://crates.io/crates/xtax)
[![docs.rs](https://docs.rs/xtax/badge.svg)](https://docs.rs/xtax)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/5f6106e413274dfcac3179c96ed643bf)](https://app.codacy.com/gh/cz-jcode/xtax/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)

Rust infrastructure ecosystem — a Cargo workspace of independent, composable crates.

Expand Down Expand Up @@ -80,6 +81,14 @@ Both paths are valid and supported.

Default features: **none**. You opt in to exactly what you need.

## Documentation

| Crate | docs.rs | Guides |
|-------|---------|--------|
| `xtax` (facade) | [docs.rs](https://docs.rs/xtax) | — |
| `xtax-blob-storage` | [docs.rs](https://docs.rs/xtax-blob-storage) | [Guide](crates/xtax-blob-storage/docs/guide.md) · [Architecture](crates/xtax-blob-storage/docs/architecture.md) · [Backends](crates/xtax-blob-storage/docs/backends.md) · [Encryption](crates/xtax-blob-storage/docs/encryption.md) · [All docs](crates/xtax-blob-storage/docs/) |
| `xtax-encryption` | [docs.rs](https://docs.rs/xtax-encryption) | [README](crates/xtax-encryption/README.md) |

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for release/publishing instructions and contribution guidelines.
Expand Down
2 changes: 1 addition & 1 deletion crates/xtax-blob-storage/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "xtax-blob-storage"
version = "0.1.0"
version = "0.1.1"
edition.workspace = true
rust-version.workspace = true
license.workspace = true
Expand Down
6 changes: 5 additions & 1 deletion crates/xtax-blob-storage/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# xtax-blob-storage

[![CI](https://github.com/cz-jcode/xtax/actions/workflows/ci.yml/badge.svg)](https://github.com/cz-jcode/xtax/actions/workflows/ci.yml)
[![CodeQL](https://github.com/cz-jcode/xtax/actions/workflows/codeql.yml/badge.svg)](https://github.com/cz-jcode/xtax/actions/workflows/codeql.yml)
[![Dependabot](https://img.shields.io/badge/dependabot-active-blue?logo=dependabot)](https://github.com/cz-jcode/xtax/network/updates)
[![crates.io](https://img.shields.io/crates/v/xtax-blob-storage.svg)](https://crates.io/crates/xtax-blob-storage)
[![docs.rs](https://docs.rs/xtax-blob-storage/badge.svg)](https://docs.rs/xtax-blob-storage)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/5f6106e413274dfcac3179c96ed643bf)](https://app.codacy.com/gh/cz-jcode/xtax/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)

> **Experimental** blob storage abstraction for Rust with filesystem and S3
> backends, streaming uploads, optional encryption, and composable layers.
Expand Down Expand Up @@ -76,7 +80,7 @@ tokio = { version = "1.52", features = ["rt", "io-util"] }

No database. No gRPC. No framework lock-in. Just blobs.

## Features
## Features flags

| Feature | Dependencies | When to use |
|---------|-------------|-----------------------|
Expand Down
2 changes: 2 additions & 0 deletions crates/xtax-blob-storage/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#![cfg_attr(docsrs, feature(doc_cfg))]

//! # xtax-blob-storage
//!
//! > **Experimental** blob storage abstraction for Rust with filesystem and S3
Expand Down
4 changes: 4 additions & 0 deletions crates/xtax-encryption/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# xtax-encryption

[![CI](https://github.com/cz-jcode/xtax/actions/workflows/ci.yml/badge.svg)](https://github.com/cz-jcode/xtax/actions/workflows/ci.yml)
[![CodeQL](https://github.com/cz-jcode/xtax/actions/workflows/codeql.yml/badge.svg)](https://github.com/cz-jcode/xtax/actions/workflows/codeql.yml)
[![Dependabot](https://img.shields.io/badge/dependabot-active-blue?logo=dependabot)](https://github.com/cz-jcode/xtax/network/updates)
[![crates.io](https://img.shields.io/crates/v/xtax-encryption.svg)](https://crates.io/crates/xtax-encryption)
[![docs.rs](https://docs.rs/xtax-encryption/badge.svg)](https://docs.rs/xtax-encryption)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/5f6106e413274dfcac3179c96ed643bf)](https://app.codacy.com/gh/cz-jcode/xtax/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)

> **Trait-only** encryption provider interface — no backend, no storage,
> no I/O decisions.
Expand Down
7 changes: 7 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,13 @@
//! | `encryption` | `xtax-encryption` | Trait-only encryption provider interface |
//! | `full` | all facade features | Enables all currently exposed facade features |
//!
//! ## Subcrate documentation
//!
//! | Crate | Documentation |
//! |-------|---------------|
//! | `xtax-blob-storage` | [docs.rs](https://docs.rs/xtax-blob-storage) |
//! | `xtax-encryption` | [docs.rs](https://docs.rs/xtax-encryption) |
//!
//! ## Architecture
//!
//! - The `xtax` facade crate contains **no logic**.
Expand Down