# Reline

[![Gem Version](https://badge.fury.io/rb/reline.svg)](https://badge.fury.io/rb/reline)
[![build](https://github.com/ruby/reline/actions/workflows/reline.yml/badge.svg)](https://github.com/ruby/reline/actions/workflows/test.yml)

## Overview

Reline is Ruby's official library for input editing and history management.

## Installation

To install it with `bundler`, add this line to your application's Gemfile:

```ruby
gem 'reline'
```

Then execute:

```console
$ bundle
```

Or install it directly with:

```console
$ gem install reline
```

## Usage

See `Reline` module for public API.

See [Face.md](rdoc-ref:reline/face.md) for customizing Reline's UI appearance.

## License

The gem is available as open source under the terms of the [Ruby License](https://www.ruby-lang.org/en/about/license.txt).
