## Getting Started

Posh TUI is a documentation viewer for Ruby developers. It works on macOS and Linux.

### Installation
It's recommended to install through homebrew.

```bash
brew install skatkov/tap/poshtui
```

Or you can download the executable manually from [github releases](https://github.com/skatkov/homebrew-tap/releases).

### Usage

Go into any Ruby project and run `posh sync`. This will download all documentation to your machine.

After that, just run `posh` inside a project and it will present a TUI interface.

It's also possible to clear all docsets from your machine by running `posh clear`.

## Contact
Please contact me at [docs@poshtui.com](mailto:docs@poshtui.com "docs@poshtui.com") for any questions, feedback, or just to chat.