https://github.com/naqvis/containerregistry.cr

Crystal library for working with container registries.
https://github.com/naqvis/containerregistry.cr

container-registries container-registry crystal crystal-lang crystal-language

Last synced: 11 days ago
JSON representation

Crystal library for working with container registries.

• Host: GitHub
• URL: https://github.com/naqvis/containerregistry.cr
• Owner: naqvis
• License: mit
• Created: 2019-07-27T12:39:26.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-07-28T04:48:25.000Z (over 5 years ago)
• Last Synced: 2024-08-01T17:36:01.747Z (3 months ago)
• Topics: container-registries, container-registry, crystal, crystal-lang, crystal-language
• Language: Crystal
• Homepage:
• Size: 367 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-crystal - containerregistry.cr - Library for working with container registries (Misc)

README

        
[![Build Status](https://travis-ci.org/naqvis/containerregistry.cr.svg?branch=master)](https://travis-ci.org/naqvis/containerregistry.cr)

[![GitHub release](https://img.shields.io/github/release/naqvis/containerregistry.cr.svg)](https://github.com/naqvis/containerregistry.cr/releases)

[![Docs](https://img.shields.io/badge/docs-available-brightgreen.svg)](https://naqvis.github.io/containerregistry.cr/)

# Crystal - Container Registry Shard

`containerregistry.cr` shard is a library for working with container registries. It's largely based on the [Go library of the same name](https://github.com/google/go-containerregistry).

The following diagram shows the main types that this library handles.

![OCI image representation](images/ociimage.jpeg)

## Installation

1. Add the dependency to your `shard.yml`:

   ```yaml

   dependencies:

     containerregistry:

       github: naqvis/containerregistry.cr

   ```

2. Run `shards install`

## Usage

```crystal

require "containerregistry"

```

Refer to [`opal`](https://github.com/naqvis/opal) for CLI and usage

## Development

To run all tests:

```

crystal spec

```

## Contributing

1. Fork it ()

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request

## Contributors

- [Ali Naqvi](https://github.com/naqvis) - creator and maintainer