Skip to content

Commit

Permalink
docs: fix CI and update crate metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
Mcdostone committed Dec 10, 2024
1 parent 09d4ca7 commit d2a40d9
Show file tree
Hide file tree
Showing 9 changed files with 14 additions and 24 deletions.
1 change: 0 additions & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,6 @@ jobs:
annotations: ${{ steps.meta.outputs.annotations }}
# https://github.com/actions/attest-build-provenance
- name: Generate artifact attestation
if: false
uses: actions/attest-build-provenance@v1
with:
subject-name: ${{ env.DOCKER_REGISTRY }}/${{ github.repository }}
Expand Down
6 changes: 3 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ WORKDIR /home/yozefu
ENTRYPOINT ["/bin/app"]


# docker pull ghcr.io/maif/yozefu:main
# gh attestation verify --owner MAIF oci://ghcr.io/maif/yozefu:main
# docker pull ghcr.io/maif/yozefu:latest
# gh attestation verify --owner MAIF oci://ghcr.io/maif/yozefu:latest
#
# docker run --rm -it ghcr.io/maif/yozefu:main -c localhost
# docker run --rm -it ghcr.io/maif/yozefu:latest -c localhost
# configuration is located at '/home/yozefu/.config/yozefu/config.json'
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Yōzefu

<a href="https://github.com/MAIF/yozefu/releases"><img src="https://img.shields.io/github/v/release/MAIF/yozefu?style=flatd&color=f8be75&logo=GitHub"></a>
<!--
<a href="https://github.com/MAIF/yozefu/releases"><img src="https://img.shields.io/github/v/release/MAIF/yozefu?style=flatd&color=f8be75&logo=GitHub"></a>-->
<a href="https://crates.io/crates/yozefu/"><img src="https://img.shields.io/crates/v/yozefu?logo=Rust"></a>
<a href="https://github.com/MAIF/yozefu/actions/workflows/build.yml"><img src="https://github.com/MAIF/yozefu/actions/workflows/build.yml/badge.svg" alt="Build status"/></a>
<a href="https://docs.rs/yozefu/"><img src="https://img.shields.io/docsrs/yozefu?logo=Rust"></a>
<a href="https://www.rust-lang.org/"><img src="https://img.shields.io/badge/MSRV-1.80.1+-lightgray.svg?logo=rust" alt="Minimum supported Rust version: 1.80.1 or plus"/></a>
<a href="https://github.com/MAIF/yozefu/blob/main/LICENSE"><img src="https://img.shields.io/github/license/MAIF/yozefu" alt="Licence"/></a>
<a href="https://github.com/MAIF/yozefu/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="Licence"/></a>


Yōzefu is an interactive terminal user interface (TUI) application for exploring data of a kafka cluster.
Expand Down
4 changes: 2 additions & 2 deletions crates/app/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[package]
name = "yozefu-app"
description = "A TUI for browsing kafka topics"
keywords = ["kafka", "consumer"]
categories = ["command-line-utilities", "development-tools"]
keywords = ["kafka", "consumer", "search", "avro"]
categories = ["command-line-utilities", "development-tools", "gui"]
readme = "README.md"
version.workspace = true
authors.workspace = true
Expand Down
5 changes: 2 additions & 3 deletions crates/bin/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
[package]
name = "yozefu"
description = "yozefu is a CLI tool for Apache kafka. It allows you to navigate topics and search Kafka records."
readme = "README.md"
keywords = ["kafka", "consumer", "ratatui"]
keywords = ["kafka", "consumer", "avro", "tui", "ratatui"]
categories = [
"command-line-utilities",
"command-line-interface",
"gui",
"development-tools",
]
Expand All @@ -15,6 +13,7 @@ edition.workspace = true
homepage.workspace = true
license.workspace = true
repository.workspace = true
readme.workspace = true

[[bin]]
name = "yozf"
Expand Down
7 changes: 0 additions & 7 deletions crates/bin/README.md

This file was deleted.

2 changes: 1 addition & 1 deletion crates/lib/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name = "yozefu-lib"
description = "Core library of yozefu"
readme = "README.md"
keywords = ["kafka", "consumer", "records"]
keywords = ["kafka", "consumer", "search", "avro"]
categories = ["data-structures", "parser-implementations"]
version.workspace = true
authors.workspace = true
Expand Down
3 changes: 1 addition & 2 deletions crates/tui/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ readme = "README.md"
categories = [
"command-line-utilities",
"gui",
"development-tools",
"visualization",
"development-tools"
]
version.workspace = true
authors.workspace = true
Expand Down
4 changes: 2 additions & 2 deletions crates/wasm-types/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
name = "yozefu-wasm-types"
readme = "README.md"
description = "Types and structures for defining WebAssembly modules"
keywords = ["wasm", "kafka"]
categories = []
keywords = ["kafka", "consumer", "search", "avro", "wasm"]
categories = ["data-structures", "wasm"]
version.workspace = true
authors.workspace = true
edition.workspace = true
Expand Down

0 comments on commit d2a40d9

Please sign in to comment.