From 9b3e5476c3b57e7f946783458347d744660baac1 Mon Sep 17 00:00:00 2001 From: Christian Rocha Date: Fri, 17 Jul 2020 14:01:48 -0400 Subject: [PATCH] Update README a little. --- README.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f96130f..62ab6f6 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,33 @@ -# Tea Party +# Bubbles -Components for [Tea](https://github.com/charmbraclet/tea) +Some components for [Bubble Tea](https://github.com/charmbraclet/bubbletea): -⚠️ This project is a pre-release! Check back later. +* Spinner +* Text Input +* Paginator +* Viewport + +## Spinner + +A spinner, useful for indicating that some kind of invisible operation is +happening. There are a couple default ones, but you can also pass your own +”frames.” + +## Text Input + +A text input field, akin to an `` in HTML. + +## Paginator + +A component for handling pagination logic and optionally drawing pagination UI. + +## Viewport + +A viewport for vertically scrolling content which optionally includes standard +pager keybindings and mouse wheel support. A high performance mode is available +for applications which make use of the alterate screen buffer. This is +generally only necessary when dealing with content with a very large amount of +ANSI escape sequences. ## License