Skip to content

Commit

Permalink
merge branch 'pr-228'
Browse files Browse the repository at this point in the history
  README: update information
  doc: site: fix typo

LGTMs: @cyphar
Closes #228
  • Loading branch information
cyphar committed Mar 5, 2018
2 parents dee8ed5 + 6489d55 commit fc69916
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 18 deletions.
42 changes: 25 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,12 @@

[![Go Report Card](https://goreportcard.com/badge/github.com/openSUSE/umoci)](https://goreportcard.com/report/github.com/openSUSE/umoci)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1084/badge)](https://bestpractices.coreinfrastructure.org/projects/1084)
[![DOI](https://zenodo.org/badge/72283469.svg)](https://zenodo.org/badge/latestdoi/72283469)

**Status: Beta**
**u**moci **m**odifies **O**pen **C**ontainer **i**mages. See [the official
website][umoci-site] for more accessible documentation about how to use umoci.

**u**moci **m**odifies **O**pen **C**ontainer **i**mages. Not a great name, but
what are you going to do. It also is a cool way for people to "dip their toe"
into OCI images ("umoci" also means "to dip" in Serbian).

`umoci` intends to be a complete manipulation tool for [OCI images][oci-image-spec].
umoci intends to be a complete manipulation tool for [OCI images][oci-image-spec].
In particular, it should be seen as a more end-user-focused version of the
[`oci-image-tools` provided by the OCI][oci-image-tools]. The hope is that all
of this tooling will eventually be merged with the upstream repository, so that
Expand All @@ -29,6 +27,7 @@ If you wish to provide feedback or contribute, read the
about how to submit good bug reports and patches. Information about how to
submit responsible security disclosures is also provided.

[umoci-site]: https://umo.ci/
[oci-image-spec]: https://github.com/opencontainers/image-spec
[oci-image-tools]: https://github.com/opencontainers/image-tools
[disc-1]: https://github.com/opencontainers/image-spec/pull/411
Expand All @@ -51,7 +50,7 @@ source code for each release from the [releases page][releases].

### Installation ###

If you wish to build `umoci` from source, follow these steps to build in with
If you wish to build umoci from source, follow these steps to build in with
[golang](https://golang.org).

```bash
Expand All @@ -65,7 +64,7 @@ Your `umoci` binary will be in `$HOME/bin`.

### Usage ###

`umoci` has a subcommand-based command-line. For more detailed information, see
umoci has a subcommand-based command-line. For more detailed information, see
the generated man pages (which you can build with `make doc`). You can also
read through our [quick start guide][quickstart].

Expand Down Expand Up @@ -110,17 +109,9 @@ GLOBAL OPTIONS:

[quickstart]: /doc/quick-start.md

### In Progress ###

Currently `umoci` relies on several from-scratch implementations of existing
PRs against upstream projects (or aliased vendor projects that include PRs
merged that are not merged upstream). This is because currently upstream
projects are simply not mature enough to be used. However, this is something
that I'm working on fixing.

### License ###

`umoci` is licensed under the terms of the Apache 2.0 license.
umoci is licensed under the terms of the Apache 2.0 license.

```
umoci: Umoci Modifies Open Containers' Images
Expand All @@ -138,3 +129,20 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

### Citation ###

If you have used umoci in your research, please cite it like you would any
other useful software. Here is a handy BibTex citation.

```
@misc{umoci,
title = {umoci - Standalone Tool For Manipulating Container Images},
author = {Aleksa Sarai et al.},
year = {2016},
url = {https://umo.ci/},
doi = {http://dx.doi.org/10.5281/zenodo.1188474},
}
```

Thank you.
2 changes: 1 addition & 1 deletion doc/site/quick-start/rootless.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ operating system that stop us from creating certain device inodes and set-uid
binaries. umoci will do its best to try to emulate the correct behaviour, and
the runtime configuration generated will further try to emulate the correct
behaviour. umoci also supports the `user.rootlesscontainers` specification,
which allows for further emulation of things like `chmod(2)` inside rootless
which allows for further emulation of things like `chown(2)` inside rootless
containers using tools like [`PRoot`][as-proot].

[as-proot]: https://github.com/AkihiroSuda/runrootless
Expand Down

0 comments on commit fc69916

Please sign in to comment.