terminimal

This README is the one indexed from the repository at its latest ref, not from the tag for this version.

# Terminimal


[![GitHub release](https://img.shields.io/github/release/aca-labs/terminimal.svg)](https://github.com/aca-labs/terminimal/releases)
[![Build Status](https://travis-ci.com/aca-labs/terminimal.svg?branch=master)](https://travis-ci.com/aca-labs/terminimal)
[![Docs](https://img.shields.io/badge/docs-available-brightgreen.svg)](https://aca-labs.github.io/terminimal/)

![](https://static.thenounproject.com/png/2130677-200.png)

Terminimal is a tiny toolkit for building CLI apps in crystal-lang that are designed for humans.

It provides a nice API and wrappers for ANSI escape sequences and a selection of useful tools for building simple, aesthetically pleasing output.

![](demo.svg)

## Installation

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

   ```yaml
   dependencies:
     terminimal:
       github: aca-labs/terminimal
   ```

2. Run `shards install`

## Usage

```crystal
require "terminimal"
```

[Read the docs](https://aca-labs.github.io/terminimal/)

## Contributing

1. Fork it (<https://github.com/aca-labs/terminimal/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

- [Kim Burgess](https://github.com/kimburgess) - creator and maintainer