Refactor README for clarity and conciseness
Removed unnecessary sections and streamlined installation instructions in the README.
This commit is contained in:
12
README.md
12
README.md
@@ -9,12 +9,8 @@ Java library for terminal UI: tables, rules, colors, prompts, menus, SelectList,
|
|||||||
|
|
||||||
[](https://codespaces.new/jakubbbdev/terminal-ui)
|
[](https://codespaces.new/jakubbbdev/terminal-ui)
|
||||||
|
|
||||||
**First time here?** → [NEXT_STEPS.md](NEXT_STEPS.md) has a short checklist (Pages, topics, release).
|
|
||||||
|
|
||||||
## Install
|
## 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):**
|
**Gradle (Kotlin DSL):**
|
||||||
|
|
||||||
```kotlin
|
```kotlin
|
||||||
@@ -53,8 +49,6 @@ dependencies {
|
|||||||
</dependency>
|
</dependency>
|
||||||
```
|
```
|
||||||
|
|
||||||
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
|
## Requirements
|
||||||
|
|
||||||
- **Java 21**
|
- **Java 21**
|
||||||
@@ -98,12 +92,6 @@ String choice = Terminal.menu()
|
|||||||
.select();
|
.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
|
## License
|
||||||
|
|
||||||
See [LICENSE](LICENSE).
|
See [LICENSE](LICENSE).
|
||||||
|
|||||||
Reference in New Issue
Block a user