Skip to content

Commit 3d3c55d

Browse files
committed
docs: refresh README status and add a Support (star + sponsor) section
1 parent 6ef7dd5 commit 3d3c55d

1 file changed

Lines changed: 18 additions & 3 deletions

File tree

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
[![CI](https://github.com/deeplabua/deepshrink/actions/workflows/ci.yml/badge.svg)](https://github.com/deeplabua/deepshrink/actions/workflows/ci.yml)
66
[![Crates.io](https://img.shields.io/crates/v/deepshrink.svg)](https://crates.io/crates/deepshrink)
77
[![License: MIT OR Apache-2.0](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](#license)
8+
[![Stars](https://img.shields.io/github/stars/deeplabua/deepshrink?style=flat&logo=github&label=Star)](https://github.com/deeplabua/deepshrink/stargazers)
89

910
`deepshrink` compresses a video or audio file to a target size in a single command.
1011
Need a clip under Discord's 8 MB limit, an email's 25 MB cap, or a Telegram / WhatsApp
@@ -14,7 +15,11 @@ without watermarks.
1415

1516
A thin, fast Rust layer over ffmpeg.
1617

17-
> **Status:** early development (pre-alpha). v0.1 targets **video and audio**.
18+
> **Status:** released and actively developed (v0.3). Handles **video and audio**, with
19+
> target-size and VMAF-quality modes, H.264/H.265, and batch processing. Install via
20+
> Homebrew or crates.io.
21+
>
22+
> If DeepShrink is useful to you, please **[⭐ star the repo](https://github.com/deeplabua/deepshrink)** — it genuinely helps. See [Support](#support) to chip in.
1823
1924
## Why
2025

@@ -118,10 +123,20 @@ installer as usual.)
118123

119124
## Scope
120125

121-
v0.1 handles **video and audio** (the ffmpeg engine). Images, PDF, and office files are a
122-
planned "universal compressor" path built on pluggable engines. GIFs are handled by a
126+
DeepShrink handles **video and audio** (the ffmpeg engine). Images, PDF, and office files
127+
are a planned "universal compressor" path built on pluggable engines. GIFs are handled by a
123128
sibling tool, DeepGif.
124129

130+
## Support
131+
132+
DeepShrink is free and open-source, built and maintained by one developer.
133+
134+
- **[⭐ Star the repo](https://github.com/deeplabua/deepshrink)** — the cheapest way to help;
135+
it boosts visibility so more people find the tool.
136+
- **Chip in a tip** via the **Sponsor** button at the top of the repo, or directly through the
137+
[monobank jar](https://send.monobank.ua/jar/9sb4WzNQwj). It supports a Ukrainian developer
138+
and keeps the project moving. Thank you 💙💛
139+
125140
## Part of DeepLab
126141

127142
DeepShrink is part of [DeepLab](https://deeplab.tools) — a line of tools for developers

0 commit comments

Comments
 (0)