Skip to content

Add container image to README #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
liry wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add container image to README #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,19 @@ performance. If you have a capable CPU and nightly rust, install it as such:
$ RUSTFLAGS="-C target-cpu=native" cargo install base100 --features simd
```

### Container image
If you e.g. don't have Cargo installed, you can use container image for simple experiments:
```shell
podman pull liry17/base100
# using file from localhost
podman run --rm -v $PWD:/workdir liry17/base100 decoded_file
# or using pipes
echo "the quick brown fox jumped over the lazy dog" | podman run -i liry17/base100
# or you can even create alias like
alias b100='podman run --rm -v $PWD:/workdir liry17/base100'
b100 decoded
```

## Performance

base💯's performance is very competitive with other encoding algorithms.
Expand Down