Skip to content

Commit 8087646

Browse files
committed
Minor edits to readme
Fix link for filing issues and update podman example. Signed-off-by: Evan Lezar <[email protected]>
1 parent a5836b2 commit 8087646

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -107,22 +107,18 @@ $ cat > /etc/cdi/vendor.json <<EOF
107107
}
108108
}
109109
EOF
110+
```
110111

111-
# CLI examples below
112-
113-
# Verbose
114-
$ docker/podman run --device vendor.com/device=myDevice --device vendor.com/device=myDevice2 ...
115-
116-
# Less verbose, through infering the vendor from the device name
117-
$ docker/podman run --device myDevice ...
112+
Assuming this specification has been generated and is available in either `/etc/cdi` or `/var/run/cdi` (or whereever a CDI-enabled consumer is configured to read CDI specifications from), the devices can be accessed through their fully-qualified device names.
118113

119-
# Special case
120-
$ docker/podman run --device vendor.com/device=all ...
114+
For example, in the case of `podman` the CLI for accessing the device would be:
115+
```
116+
$ podman run --device vendor.com/device=myDevice ...
121117
```
122118

123119
## Issues and Contributing
124120

125121
[Checkout the Contributing document!](CONTRIBUTING.md)
126122

127-
* Please let us know by [filing a new issue](https://github.com/RenaudWasTaken/cdi/issues/new)
123+
* Please let us know by [filing a new issue](https://github.com/container-orchestrated-devices/container-device-interface/issues/new)
128124
* You can contribute by opening a [pull request](https://help.github.com/articles/using-pull-requests/)

0 commit comments

Comments
 (0)