Skip to content

Commit e271a88

Browse files
authored
chore: update docs (#30)
1 parent fdf2758 commit e271a88

File tree

5 files changed

+32
-4
lines changed

5 files changed

+32
-4
lines changed

β€ŽCargo.tomlβ€Ž

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ repository = "https://github.com/opensass/cli"
1212
readme = "README.md"
1313
categories = ["wasm", "command-line-utilities", "development-tools::build-utils"]
1414
keywords = ["wasm", "rust", "cli", "components", "frontend"]
15+
exclude = ["/assets"]
1516

1617
[[bin]]
1718
name = "os"
@@ -36,7 +37,17 @@ walkdir = "2.5.0"
3637
default = []
3738

3839
[profile.release]
39-
codegen-units = 1
4040
opt-level = "z"
41+
debug = false
4142
lto = "thin"
43+
codegen-units = 1
44+
panic = "abort"
4245
strip = "symbols"
46+
incremental = false
47+
48+
[badges]
49+
maintenance = { status = "actively-developed" }
50+
51+
[package.metadata.docs.rs]
52+
all-features = true
53+
rustdoc-args = ["--cfg", "docsrs"]

β€ŽREADME.mdβ€Ž

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,17 @@
22

33
# 🧩 OpenSASS
44

5-
[![Crates.io](https://img.shields.io/crates/v/opensass.svg)](https://crates.io/crates/opensass)
6-
[![docs](https://docs.rs/opensass/badge.svg)](https://docs.rs/opensass/)
7-
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
5+
[![Crates.io](https://img.shields.io/crates/v/opensass)](https://crates.io/crates/opensass)
6+
[![Crates.io Downloads](https://img.shields.io/crates/d/opensass)](https://crates.io/crates/opensass)
7+
![Crates.io License](https://img.shields.io/crates/l/opensass)
8+
[![made-with-rust](https://img.shields.io/badge/Made%20with-Rust-1f425f.svg?logo=rust&logoColor=white)](https://www.rust-lang.org/)
9+
[![Rust](https://img.shields.io/badge/Rust-1.85%2B-blue.svg)](https://www.rust-lang.org)
10+
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/wiseaidev)
11+
12+
[![Join our Discord](https://dcbadge.limes.pink/api/server/b5JbvHW5nv)](https://discord.gg/b5JbvHW5nv)
13+
14+
<!-- absolute url for docs.rs cause assets is excluded from crate -->
15+
![logo](https://raw.githubusercontent.com/opensass/cli/refs/heads/main/assets/logo.webp)
816

917
| 🐧 Linux `(Recommended)` | πŸͺŸ Windows |
1018
| :----------------------: | :----------------------: |
@@ -50,6 +58,8 @@ cargo build --release
5058

5159
## πŸ’‘ Usage
5260

61+
<video src="https://github.com/user-attachments/assets/add61376-cdf6-4a46-9d3b-067bc4d0c4bd"></video>
62+
5363
### Add an OpenSASS component to your project
5464

5565
```sh

β€Žassets/favicon.pngβ€Ž

88.4 KB
Loading

β€Žassets/logo.webpβ€Ž

11.1 KB
Loading

β€Žsrc/lib.rsβ€Ž

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
#![doc(
2+
html_logo_url = "https://raw.githubusercontent.com/opensass/cli/refs/heads/main/assets/logo.webp",
3+
html_favicon_url = "https://github.com/opensass/cli/blob/main/assets/favicon.png"
4+
)]
5+
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
6+
#![doc = include_str!("../README.md")]
7+
18
pub mod cli;
29
pub mod cmds;
310
pub mod utils;

0 commit comments

Comments
Β (0)