diff --git a/README.md b/README.md index bac587e..d2300be 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@ Image hosting service ## Features - [NIP-96 Support](https://github.com/nostr-protocol/nips/blob/master/96.md) -- [Blossom Support](https://github.com/hzrd149/blossom/blob/master/buds/bud-01.md) -- Image compression to WebP (FFMPEG, NIP-96) +- [Blossom Support](https://github.com/hzrd149/blossom/blob/master/buds/01.md) +- Image compression to WebP (FFMPEG, NIP-96 only) - Blurhash calculation (NIP-96 only) - AI image labeling ([ViT224](https://huggingface.co/google/vit-base-patch16-224)) @@ -28,4 +28,24 @@ docker run --rm -it \ -v ./config.toml:/app/config.toml \ -e "RUST_LOG=info" \ voidic/void-cat-rs +``` + +## Building + +### Feature Flags +Default = `nip96` & `blossom` +- `nip96`: Enable NIP-96 support +- `blossom`: Enable blossom support +- `labels`: Enable AI image labeling (Depends on `nip96`) + +### Default build: +`cargo build --release` + +### Build only Blossom support +`cargo build --release --no-default-features --features blossom` + +### Build dependencies +If you want to support NIP-96 you will need the following dependencies: +```bash +libavcodec-dev libavformat-dev libswscale-dev libavutil-dev libavdevice-dev libavfilter-dev ``` \ No newline at end of file