Sha256: 44444450180ad127e9b817cc48ae858d63e2ab47636adc7f4861a7c25603360e

Contents?: true

Size: 1.31 KB

Versions: 2

Compression:

Stored size: 1.31 KB

Contents

# KittikRb::Cursor

![Build Status](https://img.shields.io/travis/kittikrb/cursor.svg)

Implements low-level API for access to cursor in terminal.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'kittikrb-cursor'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install kittikrb-cursor

## Usage

```ruby
require 'kittikrb/cursor'

cursor = KittikRb::Cursor.create.reset_tty!
```

See detailed usage examples in `examples` directory.

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kittikrb-cursor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
kittikrb-cursor-3.0.1 README.md
kittikrb-cursor-0.1.0 README.md