# containerregistry.cr

**Repository Path**: naqvis/containerregistry.cr

## Basic Information

- **Project Name**: containerregistry.cr
- **Description**: Crystal library for working with container registries.
- **Primary Language**: Crystal
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-06-16
- **Last Updated**: 2021-06-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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 (<https://github.com/naqvis/containerregistry.cr/fork>)
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