README
¶
CNAB to OCI
The intent of CNAB to OCI is to provide a translation tool in between the two formats
Getting Started
To get and build the project:
$ go get github.com/docker/cnab-to-oci
$ cd $GOPATH/src/github.com/docker/cnab-to-oci
$ make
By now you should have a binary of the project in the bin folder. To run it, execute:
$ bin/cnab-to-oci --help
Prerequisites
Make Golang 1.9 Git
Installing
For installing, make sure your $GOPATH/bin makes part of the $PATH
$ make install
This will build and install cnab-to-oci into $GOPATH/bin
Development
Running the tests
$ make test
Running the e2e tests
$ make e2e
Using it as a dependency on your project
Please refer to godoc.org
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Maintainers
See also the list of maintainers who participated in this project.
Contributors
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE file for details
Documentation
¶
Overview ¶
Package cnabtooci provides converters to transform CNAB to OCI format and vice versa In `cmd/cnab-to-oci` you can find the `main` package to create the `cnab-to-oci` binary see https://github.com/docker/cnab-to-oci for more information about it.
It can also be used as a library. For more, please refer to http://godoc.org/github.com/docker/cnab-to-oci The main functions are located in the remotes package, and they are:
remotes.Pull in https://github.com/docker/cnab-to-oci/blob/master/remotes/pull.go
remotes.Push in https://github.com/docker/cnab-to-oci/blob/master/remotes/push.go
remotes.Fixup in https://github.com/docker/cnab-to-oci/blob/master/remotes/fixup.go
Source Files
Directories