Skip to content

Commit ffdd704

Browse files
committed
README: Document the project and scope
Signed-off-by: W. Trevor King <[email protected]>
1 parent d00530d commit ffdd704

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# OCI command-line API
2+
3+
The [OCI Specifications][specs] currently focus on the bundle-author ↔ runtime interface, but there is renewed interest in specifying a command-line API for the runtime-caller ↔ runtime interface.
4+
A common command-line API would make it easier to build higher-level tools that are runtime-agnostic (e.g. conformance testers like [ocitools][ocitools-test]).
5+
This repository contains initial work on that API, with more detailed discussion in [this thread][thread].
6+
The usual [development rules][rules] apply, and the legal stuff is spelled out [here](CONTRIBUTING.md).
7+
The target for the inital design will be to match [the lifecycle pull request][lifecycle], keeping as much similarity with the existing [runC][] command-line as possible.
8+
9+
[specs]: https://github.com/opencontainers/specs
10+
[ocitools-test]: https://github.com/mrunalp/ocitools#testing-oci-runtimes
11+
[thread]: https://groups.google.com/a/opencontainers.org/forum/#!topic/dev/BIxya5eSNLo
12+
[rules]: https://github.com/opencontainers/specs#contributing
13+
[lifecycle]: https://github.com/opencontainers/specs/pull/231
14+
[runC]: https://github.com/opencontainers/runc

0 commit comments

Comments
 (0)