gobang/README.md

<div align="center">

# gobang

gobang is currently in alpha

A cross-platform terminal database tool written in Rust

[![github workflow status](https://img.shields.io/github/workflow/status/TaKO8Ki/gobang/CI/main)](https://github.com/TaKO8Ki/gobang/actions) [![crates](https://img.shields.io/crates/v/gobang.svg?logo=rust)](https://crates.io/crates/gobang)

![gobang](./resources/gobang.gif)

</div>

## Features

- Cross-platform support (macOS, Windows, Linux)
- Multiple Database support (MySQL PostgreSQL, SQLite)
- Intuitive keyboard only control

## Installation

### Cargo

If you already have a Rust environment set up, you can use the `cargo install` command:

```
$ cargo install --version 0.1.0-alpha.0 gobang
```
## Keymap

| Key | Description |
| ---- | ---- |
| <kbd>h</kbd> | scroll left |
| <kbd>j</kbd> | scroll down |
| <kbd>k</kbd> | scroll up |
| <kbd>l</kbd> | scroll right |
| <kbd>Ctrl</kbd> + <kbd>d</kbd> | scroll down multiple lines |
| <kbd>Ctrl</kbd> + <kbd>u</kbd> | scroll up multiple lines |
Update README.md 3 years ago			`<div align="center">`

replace goban with gobang 3 years ago			`# gobang`
Update README.md 3 years ago
update README 3 years ago			`gobang is currently in alpha`

Create README.md 3 years ago			`A cross-platform terminal database tool written in Rust`
Update README.md 3 years ago
Refactor handlers (#3) * fix workflows * remove a unused function * initialize record table state every time specifying table * add a crates.io badge * close pool if exists * remove unneeded lines * change gobang.gif * fix layout * update gobang.gif * refactor `utils::get_records` * refactor handlers * change gobang.gif * fix clippy warnings 3 years ago			`[![github workflow status](https://img.shields.io/github/workflow/status/TaKO8Ki/gobang/CI/main)](https://github.com/TaKO8Ki/gobang/actions) [![crates](https://img.shields.io/crates/v/gobang.svg?logo=rust)](https://crates.io/crates/gobang)`
Update README.md 3 years ago
Architecture (#1) * layout * architecture * implement side-scrolling * implement util functions * use user config * use config conn * remove cache * fix user config * add useful functions * remov mut * cargo clippy --fix * cargo fmt * implement some handlers * add gif * chang gif 3 years ago			`![gobang](./resources/gobang.gif)`

Update README.md 3 years ago			`</div>`
Select one specific Cell (#14) * select a cell * add tests for headers and rows * fix redundant codes * update README * update gobang.gif 3 years ago
			`## Features`

			`- Cross-platform support (macOS, Windows, Linux)`
			`- Multiple Database support (MySQL PostgreSQL, SQLite)`
			`- Intuitive keyboard only control`
update README 3 years ago
			`## Installation`

			`### Cargo`

			If you already have a Rust environment set up, you can use the `cargo install` command:

			```
			`$ cargo install --version 0.1.0-alpha.0 gobang`
			```
Make table cells responsive (#23) * make table cells responsive * add workspace flag * fix compile error * scrolling responsive cells * horizontal scrolling without numbers * fix limit * add row number * implement TEXT type * remove unused functions * add keymap and update gobang.gif * add a test for `calculate_widths` * remove a debug line 3 years ago			`## Keymap`

			`\| Key \| Description \|`
			`\| ---- \| ---- \|`
Add key config (#33) * implement key config * use key config in help component * use key config in databases component * use key config in error component * use key config in connections component * set commands * use database/table as a table component name * fix a test for get_text * use key config in tab component * fix function name * add focus_connections key * use quit exit key 3 years ago			`\| <kbd>h</kbd> \| scroll left \|`
			`\| <kbd>j</kbd> \| scroll down \|`
			`\| <kbd>k</kbd> \| scroll up \|`
			`\| <kbd>l</kbd> \| scroll right \|`
Make table cells responsive (#23) * make table cells responsive * add workspace flag * fix compile error * scrolling responsive cells * horizontal scrolling without numbers * fix limit * add row number * implement TEXT type * remove unused functions * add keymap and update gobang.gif * add a test for `calculate_widths` * remove a debug line 3 years ago			`\| <kbd>Ctrl</kbd> + <kbd>d</kbd> \| scroll down multiple lines \|`
			`\| <kbd>Ctrl</kbd> + <kbd>u</kbd> \| scroll up multiple lines \|`