Skip to content

Commit

Permalink
feat: Publish the project to Cargo (#201)
Browse files Browse the repository at this point in the history
* feat: Publish the project to Cargo

* doc: Add instructions on installing the project using Cargo
  • Loading branch information
kurosakishigure authored Jan 1, 2025
1 parent cf224c8 commit 2633d39
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .github/workflows/cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,14 @@ jobs:
files: |
katharsis-*-${{ matrix.job.target }}.*
katharsis*.deb
publish-to-cargo:
name: Publishing to Cargo
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Installing Rust toolchain
uses: dtolnay/rust-toolchain@stable
- name: Cargo publish
run: cargo publish --token ${{ secrets.CARGO_API_KEY }}
9 changes: 9 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
[package]
name = "katharsis"
authors = ["Shigure Kurosaki <[email protected]>"]
version = "1.0.0-canary.20"
edition = "2021"
license = "MIT"
categories = ["command-line-utilities"]
homepage = "https://github.com/kurosakishigure/katharsis"
repository = "https://github.com/kurosakishigure/katharsis"
description = "CLI tool for generating RSS feeds."
include = ["/src", "README.md", "LICENSE", "Cargo.toml", "Cargo.lock"]

[lints.clippy]
pedantic = "warn"

[[bin]]
name = "katharsis"

[dependencies]
anyhow = "1.0.95"
chrono = "0.4.39"
Expand Down
6 changes: 6 additions & 0 deletions docs/USE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ If you're using a Debian-based system, you can directly install the .deb file fr
sudo apt install katharsis.deb
```

If you are using Cargo, please run:

```bash
cargo install katharsis
```

Otherwise, you'll need to follow the step-by-step instructions below to install Katharsis.

Run the following command to extract the downloaded file:
Expand Down

0 comments on commit 2633d39

Please sign in to comment.