Kieran/route96
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme

Browse Source 
closes #3
This commit is contained in:
Kieran 2024-08-30 19:58:36 +01:00
parent ab4ff7b035
commit f9cdc6d85e
No known key found for this signature in database
GPG Key ID: DE71CEB3925BE941
1 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -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))
@ -29,3 +29,23 @@ docker run --rm -it \
-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
```