Skip to content

Commit

Permalink
Release v0.0.1-b
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
dormant-user committed Feb 10, 2024
1 parent e599dea commit 9ca142a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# https://doc.rust-lang.org/cargo/getting-started/first-steps.html#first-steps-with-cargo
[package]
name = "rustream"
version = "0.0.1-a"
version = "0.0.1-b"
description = "An API written in Rust, to stream videos using Actix framework, via authenticated sessions"
license = "MIT"
documentation = "https://thevickypedia.github.io/RuStream"
Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,16 @@

[![made-with-rust](https://img.shields.io/badge/Made%20with-Rust-black?style=for-the-badge&logo=Rust)][rust]

[![build](https://github.com/thevickypedia/RuStream/actions/workflows/release.yml/badge.svg)][build]
[![build](https://github.com/thevickypedia/RuStream/actions/workflows/rust.yml/badge.svg)][build]

#### Summary
[`RuStream`][1] is an application written in Rust to stream videos using Actix API via authenticated sessions.

## Usage

#### Download Executable
<details>
<summary><strong>Download OS specific Executable</strong></summary>

###### macOS
```shell
curl -o asset -LH "Accept: application/octet-stream" "https://github.com/thevickypedia/RuStream/releases/latest/download/RuStream-Darwin-x86_64.tar.gz"
Expand All @@ -29,6 +31,7 @@ curl -o asset -LH "Accept: application/octet-stream" "https://github.com/thevick
```shell
curl -o asset -LH "Accept: application/octet-stream" "https://github.com/thevickypedia/RuStream/releases/latest/download/RuStream-Windows-x86_64.zip"
```
</details>

#### Arguments
- `debug` - Enable debug level logging
Expand Down Expand Up @@ -57,5 +60,5 @@ Licensed under the [MIT License][2]

[1]: https://github.com/thevickypedia/RuStream
[2]: https://github.com/thevickypedia/RuStream/blob/main/LICENSE
[build]: https://github.com/thevickypedia/RuStream/actions/workflows/release.yml
[build]: https://github.com/thevickypedia/RuStream/actions/workflows/rust.yml
[rust]: https://www.rust-lang.org/

0 comments on commit 9ca142a

Please sign in to comment.