Skip to content

Commit

Permalink
Update README.md and GH workflows
Browse files Browse the repository at this point in the history
  • Loading branch information
dormant-user committed Feb 18, 2024
1 parent 5753a30 commit 189c5da
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 11 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/none.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: none-shall-pass
name: Validate Hyperlinks

on:
workflow_dispatch:
Expand All @@ -14,3 +14,5 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: thevickypedia/none-shall-pass@v4
with:
excludeHostnames: "crates docs"
2 changes: 2 additions & 0 deletions .github/workflows/rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ on:
push:
branches:
- main
paths-ignore:
- '.github/**'

env:
CARGO_TERM_COLOR: always
Expand Down
27 changes: 17 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,10 @@

[![made-with-rust][rust-logo]][rust-src-page]

[![build][gh-logo]][build]

[![crates.io][crates-logo]][crate]

**Platform Supported**

[![platform][platform]][cross-platform]
[![build][gh-logo]][build]
[![none-shall-pass][nsp-logo]][nsp]

#### Summary
[`RuStream`][repo] is a self-hosted streaming engine, that can render videos via authenticated sessions.
Expand Down Expand Up @@ -85,9 +82,6 @@ async fn main() {
```
</details>

## Crate
[https://crates.io/crates/RuStream][crate]

## Linting
### Requirement
```shell
Expand All @@ -98,6 +92,17 @@ rustup component add clippy
cargo clippy --no-deps --fix --allow-dirty
```

## Docs
### [Cargo Docs][docs]
```shell
cargo doc --document-private-items --no-deps
```

#### [GitHub Wiki][gh-wiki]

## Crate
[https://crates.io/crates/RuStream][crate]

## License & copyright

&copy; Vignesh Rao
Expand All @@ -110,8 +115,10 @@ Licensed under the [MIT License][license]
[rust-src-page]: https://www.rust-lang.org/
[rust-logo]: https://img.shields.io/badge/Made%20with-Rust-black?style=for-the-badge&logo=Rust
[gh-logo]: https://github.com/thevickypedia/RuStream/actions/workflows/rust.yml/badge.svg
[nsp-logo]: https://github.com/thevickypedia/RuStream/actions/workflows/none.yml/badge.svg
[nsp]: https://github.com/thevickypedia/RuStream/actions/workflows/none.yml
[crate]: https://crates.io/crates/RuStream
[gh-checks]: https://github.com/thevickypedia/RuStream/actions/workflows/rust.yml
[crates-logo]: https://img.shields.io/crates/v/RuStream.svg
[platform]: https://img.shields.io/badge/Platform-Linux_|_macOS_|_Windows-blue?style=for-the-badge&logo=ubuntu
[cross-platform]: https://www.computerlanguage.com/results.php?definition=cross+platform
[gh-wiki]: https://github.com/thevickypedia/RuStream/wiki
[docs]: https://docs.rs/RuStream/latest/rustream/

0 comments on commit 189c5da

Please sign in to comment.