Skip to content

Commit f2cd92f

Browse files
nbdd0121jwnrt
andcommitted
Apply README suggestions from code review
Co-authored-by: James Wainwright <james.wainwright@lowrisc.org>
1 parent f35e976 commit f2cd92f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ This program tries to provide a similar functionality for containers, allowing y
2727

2828
## Usage
2929

30-
This tool wraps `runc` command, with the additional hotplug feature. Therefore, it can be used as a drop in replace for
31-
many container managers/orchestrators that makes use of runc as runtime. You need to ensure `runc` is available in your `PATH`
30+
This tool wraps `runc` with the additional hotplug feature, therefore it can be used as a drop in replace for
31+
many container managers/orchestrators such as Docker, Podman, and Kubernetes. You need to ensure `runc` is available in your `PATH`
3232
so `container-hotplug` can find it.
3333

3434
It supports two annotations, `org.lowrisc.hotplug.device` and `org.lowrisc.hotplug.symlinks`.
@@ -43,7 +43,7 @@ For Docker, you can specify an alternative runtime by [changing /etc/docker/daem
4343
}
4444
}
4545
```
46-
and use it by `--runtime hotplug` and appropriate annotation, e.g.
46+
and use it with the `--runtime hotplug` flag and appropriate annotation, e.g.
4747
```bash
4848
sudo docker run --runtime hotplug -it --annotation org.lowrisc.hotplug.device=parent-of:usb:2b2e:c310 ubuntu:latest
4949
```
@@ -53,7 +53,7 @@ For podman, you can specify the path directly, by:
5353
sudo podman run --runtime /path/to/container-hotplug/binary -it --annotation org.lowrisc.hotplug.device=parent-of:usb:2b2e:c310 ubuntu:latest
5454
```
5555

56-
For containerd (e.g. when using kubernetes), you can `/etc/containerd/config.toml` to add:
56+
For containerd (e.g. when using kubernetes), you can edit `/etc/containerd/config.toml` to add:
5757
```toml
5858
[plugins."io.containerd.grpc.v1.cri".containerd.runtimes.hotplug]
5959
runtime_type = "io.containerd.runc.v2"
@@ -71,7 +71,7 @@ metadata:
7171
name: hotplug
7272
handler: hotplug
7373
```
74-
and use it in pod with
74+
and use it in a pod with
7575
```yaml
7676
apiVersion: v1
7777
kind: Pod

0 commit comments

Comments
 (0)