Skip to content

Commit 0e5c5bd

Browse files
committed
docs(readme): update description
1 parent bd9a074 commit 0e5c5bd

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,53 @@
11
# Markdown
22

3-
Multi-platform Docker container with utilities to process audiovisual media (`ffmpeg`, `mkvtoolnix`, `mlt`, `flac`, `mp3splt`...).
3+
Multi-platform Docker container with utilities to process Markdown files (`asciidoc`, `a2x`, `ascidoctor`...).
44

5-
[![Dockerfile](https://img.shields.io/badge/GitHub-Dockerfile-blue)](av/Dockerfile)
6-
[![Docker Build](https://github.com/leplusorg/docker-av/workflows/Docker/badge.svg)](https://github.com/leplusorg/docker-av/actions?query=workflow:"Docker")
7-
[![Docker Stars](https://img.shields.io/docker/stars/leplusorg/av)](https://hub.docker.com/r/leplusorg/av)
8-
[![Docker Pulls](https://img.shields.io/docker/pulls/leplusorg/av)](https://hub.docker.com/r/leplusorg/av)
9-
[![Docker Version](https://img.shields.io/docker/v/leplusorg/av?sort=semver)](https://hub.docker.com/r/leplusorg/av)
5+
[![Dockerfile](https://img.shields.io/badge/GitHub-Dockerfile-blue)](md/Dockerfile)
6+
[![Docker Build](https://github.com/leplusorg/docker-md/workflows/Docker/badge.svg)](https://github.com/leplusorg/docker-md/actions?query=workflow:"Docker")
7+
[![Docker Stars](https://img.shields.io/docker/stars/leplusorg/md)](https://hub.docker.com/r/leplusorg/md)
8+
[![Docker Pulls](https://img.shields.io/docker/pulls/leplusorg/md)](https://hub.docker.com/r/leplusorg/md)
9+
[![Docker Version](https://img.shields.io/docker/v/leplusorg/md?sort=semver)](https://hub.docker.com/r/leplusorg/md)
1010
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/10081/badge)](https://bestpractices.coreinfrastructure.org/projects/10081)
11-
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/leplusorg/docker-av/badge)](https://securityscorecards.dev/viewer/?uri=github.com/leplusorg/docker-av)
11+
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/leplusorg/docker-md/badge)](https://securityscorecards.dev/viewer/?uri=github.com/leplusorg/docker-md)
1212

1313
## Example without using the filesystem
1414

15-
Let's say that you have a MP3 `foo.mp3` in your current working directory that you want to extract its metadata:
15+
Let's say that you want to convert an Markdown file intput.md in your current working directory to HTML:
1616

1717
**Mac/Linux**
1818

1919
```bash
20-
cat foo.mp3 | docker run --rm -i --net=none leplusorg/av ffprobe -v error -show_streams -
20+
cat intput.md | docker run --rm -i --net=none leplusorg/md asciidoc -o - > output.html
2121
```
2222

2323
**Windows**
2424

2525
```batch
26-
type foo.mp3 | docker run --rm -i --net=none leplusorg/av ffprobe -v error -show_streams -
26+
type intput.md | docker run --rm -i --net=none leplusorg/md asciidoc -o - > output.html
2727
```
2828

2929
## Example using the filesystem
3030

31-
Same thing, assuming that you have a MP3 `foo.mp3` in your current working directory that you want to extract its metadata:
31+
Same thing, assuming that you want to convert an Markdown file intput.md in your current working directory to HTML:
3232

3333
**Mac/Linux**
3434

3535
```bash
36-
docker run --rm -t --user="$(id -u):$(id -g)" --net=none -v "$(pwd):/tmp" leplusorg/av ffprobe -v error -show_streams /tmp/foo.mp3
36+
docker run --rm -t --user="$(id -u):$(id -g)" --net=none -v "$(pwd):/tmp" leplusorg/md asciidoc -o output.html intput.md
3737
```
3838

3939
**Windows**
4040

4141
In `cmd`:
4242

4343
```batch
44-
docker run --rm -t --net=none -v "%cd%:/tmp" leplusorg/av ffprobe -v error -show_streams /tmp/foo.mp3
44+
docker run --rm -t --net=none -v "%cd%:/tmp" leplusorg/md asciidoc -o output.html intput.md
4545
```
4646

4747
In PowerShell:
4848

4949
```pwsh
50-
docker run --rm -t --net=none -v "${PWD}:/tmp" leplusorg/av ffprobe -v error -show_streams /tmp/foo.mp3
50+
docker run --rm -t --net=none -v "${PWD}:/tmp" leplusorg/md asciidoc -o output.html intput.md
5151
```
5252

5353
## Software Bill of Materials (SBOM)
@@ -56,7 +56,7 @@ To get the SBOM for the latest image (in SPDX JSON format), use the
5656
following command:
5757

5858
```bash
59-
docker buildx imagetools inspect leplusorg/av --format '{{ json (index .SBOM "linux/amd64").SPDX }}'
59+
docker buildx imagetools inspect leplusorg/md --format '{{ json (index .SBOM "linux/amd64").SPDX }}'
6060
```
6161

6262
Replace `linux/amd64` by the desired platform (`linux/amd64`, `linux/arm64` etc.).
@@ -65,17 +65,17 @@ Replace `linux/amd64` by the desired platform (`linux/amd64`, `linux/arm64` etc.
6565

6666
[Sigstore](https://docs.sigstore.dev) is trying to improve supply
6767
chain security by allowing you to verify the origin of an
68-
artifcat. You can verify that the jar that you use was actually
68+
artifcat. You can verify that the image that you use was actually
6969
produced by this repository. This means that if you verify the
70-
signature of the ristretto jar, you can trust the integrity of the
70+
signature of the Docker image, you can trust the integrity of the
7171
whole supply chain from code source, to CI/CD build, to distribution
72-
on Maven Central or whever you got the jar from.
72+
on Maven Central or whever you got the image from.
7373

7474
You can use the following command to verify the latest image using its
7575
sigstore signature attestation:
7676

7777
```bash
78-
cosign verify leplusorg/av --certificate-identity-regexp 'https://github\.com/leplusorg/docker-av/\.github/workflows/.+' --certificate-oidc-issuer 'https://token.actions.githubusercontent.com'
78+
cosign verify leplusorg/md --certificate-identity-regexp 'https://github\.com/leplusorg/docker-md/\.github/workflows/.+' --certificate-oidc-issuer 'https://token.actions.githubusercontent.com'
7979
```
8080

8181
The output should look something like this:
@@ -94,4 +94,4 @@ For instructions on how to install `cosign`, please read this [documentation](ht
9494

9595
## Request new tool
9696

97-
Please use [this link](https://github.com/leplusorg/docker-av/issues/new?assignees=thomasleplus&labels=enhancement&template=feature_request.md&title=%5BFEAT%5D) (GitHub account required) to request that a new tool be added to the image. I am always interested in adding new capabilities to these images.
97+
Please use [this link](https://github.com/leplusorg/docker-md/issues/new?assignees=thomasleplus&labels=enhancement&template=feature_request.md&title=%5BFEAT%5D) (GitHub account required) to request that a new tool be added to the image. I am always interested in adding new capabilities to these images.

0 commit comments

Comments
 (0)