Skip to content

Commit

Permalink
docs: add README
Browse files Browse the repository at this point in the history
  • Loading branch information
metafates committed Jan 5, 2024
1 parent 423b55f commit 49d741e
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# 🥤 Soda

Framework for building TUI apps based on the [bubbletea](https://github.com/charmbracelet/bubbletea).

It automatically handles state management and general layout, so that you can focus on app functionality rather than fighting with TTY 🤕🥊🖥️

## Install

```bash
go get github.com/tuiphi/soda
```

## Examples

Take a look at the [examples folder](./_examples)

## Why?

I write TUI apps a lot. And after some trial and error I came up with the structure that suits me the best. I've been copy-pasting it for my projects again and again, so I decided to create a separate package for it so that others can benefit from it too.

0 comments on commit 49d741e

Please sign in to comment.