From 047dcf3f4db282b816ac5088de4d459152ff42de Mon Sep 17 00:00:00 2001 From: !verity Date: Sat, 14 Mar 2026 10:19:13 +0100 Subject: [PATCH] Refactor README for clarity and conciseness Removed unnecessary sections and streamlined installation instructions in the README. --- README.md | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/README.md b/README.md index d1b6143..959ded7 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,8 @@ Java library for terminal UI: tables, rules, colors, prompts, menus, SelectList, [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/jakubbbdev/terminal-ui) -**First time here?** → [NEXT_STEPS.md](NEXT_STEPS.md) has a short checklist (Pages, topics, release). - ## Install -Published to [GitHub Packages](https://github.com/jakubbbdev/terminal-ui/packages). Replace `VERSION` with a [release](https://github.com/jakubbbdev/terminal-ui/releases) tag (e.g. `1.0.0`). - **Gradle (Kotlin DSL):** ```kotlin @@ -53,8 +49,6 @@ dependencies { ``` -For public packages, read access usually works without credentials. If your tool asks for auth, use a [GitHub PAT](https://github.com/settings/tokens) with `read:packages` as username and the token as password. - ## Requirements - **Java 21** @@ -98,12 +92,6 @@ String choice = Terminal.menu() .select(); ``` -## Docs & links - -- **In-repo docs:** [docs/](docs/) – Home, Install, Components, Examples. -- **GitHub Pages:** Enable in **Settings → Pages → Source: GitHub Actions** (uses workflow `pages.yml`). Site: `https://jakubbbdev.github.io/terminal-ui/`. -- **Wiki:** **Settings → Features** → enable **Wiki**; copy content from `docs/` if you like. - ## License See [LICENSE](LICENSE).