Update Cargo.toml, README.md and release v0.0.1-alpha

Cargo.toml

@@ -1,39 +1,33 @@
 # https://doc.rust-lang.org/cargo/getting-started/first-steps.html#first-steps-with-cargo
 [package]
 name = "RuStream"
-version = "0.0.0-a"
-description = "Rustic API to stream videos from localhost"
+version = "0.0.1-alpha"
+description = "Rustic API to stream videos via authenticated sessions"
 license = "MIT"
-documentation = "https://thevickypedia.github.io/rustic-stream"
-homepage = "https://github.com/thevickypedia/rustic-stream"
-repository = "https://github.com/thevickypedia/rustic-stream"
+documentation = "https://thevickypedia.github.io/RuStream"
+homepage = "https://github.com/thevickypedia/RuStream"
+repository = "https://github.com/thevickypedia/RuStream"
 edition = "2021"
 
 [[bin]]
 name = "stream"
 path = "src/main.rs"
 
-[target.'cfg(windows)'.dependencies]
-openssl-sys = "0.9"
-
 [dependencies]
 actix-rt = "2.9.0"
 actix-web = "4.4.1"
 actix-files = "0.6.5"
 serde = { version = "1.0.106", features = ["derive"] }
 serde_json = "1.0.51"
 chrono = { version = "0.4", features = ["serde"] }
-uuid = { version = "1.7.0", features = ["serde", "v4"] }
 env_logger = "0.11.1"
 log = "0.4.20"
-futures-util = "0.3.30"
 lazy_static = "1.4.0"
 base64 = "0.21.7"
 sha2 = "0.10.8"
 rand = "0.8.5"
 fernet = "0.2.1"
 minijinja = "1.0.12"
-walkdir = "2.3"
 pyo3 = { version = "0.20.2", features = ["auto-initialize"] }
 url = "2.2.1"
 itertools = "0.12.1"

README.md

@@ -1,2 +1,61 @@
 # RuStream
-Rustic API to stream videos from localhost
+
+[![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]
+
+#### Summary
+[`RuStream`][1] is an application written in Rust to stream videos using Actix API via authenticated sessions.
+
+## Usage
+
+#### Download Executable
+###### macOS
+```shell
+curl -o asset -LH "Accept: application/octet-stream" "https://github.com/thevickypedia/RuStream/releases/latest/download/RuStream-Darwin-x86_64.tar.gz"
+```
+
+###### Linux
+```shell
+curl -o asset -LH "Accept: application/octet-stream" "https://github.com/thevickypedia/RuStream/releases/latest/download/RuStream-Linux-x86_64.tar.gz"
+```
+
+###### RaspberryPi
+```shell
+curl -o asset -LH "Accept: application/octet-stream" "https://github.com/thevickypedia/RuStream/releases/latest/download/RuStream-RaspberryPi.tar.gz"
+```
+
+###### Windows
+```shell
+curl -o asset -LH "Accept: application/octet-stream" "https://github.com/thevickypedia/RuStream/releases/latest/download/RuStream-Windows-x86_64.zip"
+```
+
+#### Arguments
+- `debug` - Enable debug level logging
+
+#### Flags
+- `--filename` / `-f` - Filename (JSON) for the secrets config
+
+## Crate
+https://crates.io/crates/RuStream
+
+## Linting
+### Requirement
+```shell
+rustup component add clippy
+```
+### Usage
+```shell
+cargo clippy --no-deps --fix --allow-dirty
+```
+
+## License & copyright
+
+© Vignesh Rao
+
+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
+[rust]: https://www.rust-lang.org/