tooters 0.0.2

A Rust TUI-based Mastodon App
Documentation
# Tooters: A Rust TUI-based Mastodon App

Tooters is a Rust-based Terminal User Interface (TUI) Mastodon app that allows you to view multiple toots on the screen at once. The project was created as a means to learn Rust and scratch a personal itch - the desire to see multiple toots on the screen at once. See the awesome python based [toot](https://github.com/ihabunek/toot), for something more complete.

Visit our website at [toote.rs](https://toote.rs) (TODO) for more information and updates.

## Features

- View multiple toots on the screen at once
- Rust-based TUI for a fast and efficient user experience
- Easy navigation and interaction with toots

## Installation

To install Tooters, you need to have Rust and Cargo installed on your system. If you don't have them installed, follow the instructions on the [official Rust website](https://www.rust-lang.org/tools/install).

Once Rust and Cargo are installed, you can install Tooters by running the following command:

```bash
cargo install tooters
```

## Usage

To start using Tooters, simply run the following command in your terminal:

```bash
tooters
```

You will be prompted to enter your Mastodon instance URL and login credentials. Once logged in, you can navigate and interact with toots using the keyboard shortcuts provided.

## Keyboard Shortcuts

- [x] `j` or ``: Move down
- [x] `k` or ``: Move up
- [ ] `h` or ``: Move left (switch column)
- [ ] `l` or ``: Move right (switch column)
- [ ] `n`: Compose a new toot
- [ ] `r`: Reply to the selected toot
- [ ] `b`: Boost the selected toot
- [ ] `f`: Favourite the selected toot
- [ ] `q`: Quit Tooters

## Contributing

We welcome contributions to Tooters! If you'd like to contribute, please fork the repository, make your changes, and submit a pull request. If you find any bugs or have feature requests, please open an issue on the GitHub repository.

## License

Tooters is released under the MIT License. See the [LICENSE](LICENSE) file for more information.