Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Valkyrie00 committed Feb 22, 2025
1 parent de5d495 commit 91021c7
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 23 deletions.
81 changes: 59 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,88 @@
<div align="center">
<img src="resources/logo/bbrew-logo-rounded.png" alt="Bold Brew Logo" width="200" height="200">
<h1>Bold Brew (bbrew)</h1>
<p>A Homebrew TUI Manager</p>
</div>

# Bold Brew (bbrew) - A Homebrew TUI Manager

![GitHub Repo stars](https://img.shields.io/github/stars/Valkyrie00/bold-brew?style=social) ![GitHub forks](https://img.shields.io/github/forks/Valkyrie00/bold-brew?style=social) ![GitHub watchers](https://img.shields.io/github/watchers/Valkyrie00/bold-brew?style=social)
<div align="center">

![GitHub release (latest by date)](https://img.shields.io/github/v/release/Valkyrie00/bold-brew)
![GitHub](https://img.shields.io/github/license/Valkyrie00/bold-brew)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/Valkyrie00/bold-brew/release.yml)
![GolangCI-Lint](https://github.com/Valkyrie00/bold-brew/workflows/Quality/badge.svg)
![GitHub all releases](https://img.shields.io/github/downloads/Valkyrie00/bold-brew/total)

**Bold Brew** is a TUI application that allows you to manage your Homebrew packages on macOS. It provides a simple and intuitive interface to install, uninstall, and update packages. It also allows you to search for packages and view detailed information about them.
[![GitHub stars](https://img.shields.io/github/stars/Valkyrie00/bold-brew?style=social)](https://github.com/Valkyrie00/bold-brew/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/Valkyrie00/bold-brew?style=social)](https://github.com/Valkyrie00/bold-brew/network/members)

<img src="resources/screenshots/main.png" alt="Bold Brew Screenshot" style="max-width: 1024px;">
<img src="resources/screenshots/installed.png" alt="Bold Brew Screenshot" style="max-width: 1024px;">
[Website](https://bold-brew.com/) β€’ [Documentazione](https://bold-brew.com/docs) β€’ [Changelog](CHANGELOG.md)

## πŸ“š Table of Contents
</div>

- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## ✨ Features

## πŸ’Ύ Installation
You can also install **Bold Brew** using Homebrew:
- πŸš€ Modern and responsive TUI interface
- πŸ“¦ Simplified Homebrew package management
- πŸ” Advanced package search
- πŸ”„ Real\-time updates
- ⌨️ Intuitive keyboard shortcuts

## πŸ› οΈ Installation

### Via Homebrew
```sh
brew tap Valkyrie00/homebrew-bbrew
brew install bbrew
```

You can download the latest release of **Bold Brew** from the [releases page](https://github.com/Valkyrie00/bold-brew/releases).

### Manuale
Download the latest version from the [releases page](https://github.com/Valkyrie00/bold-brew/releases)

## πŸ“– Quick Guide

## πŸš€ Usage
To run **Bold Brew** simply execute:
Launch the application:
```sh
bbrew
```
This will launch the TUI application where you can navigate and manage your Homebrew packages.

### Main Commands
- `/` - Search packages
- `f` - Filter installed packages
- `i` - Install package
- `u` - Update package
- `r` - Remove package
- `q` - Quit
- `Ctrl+U` - Update all packages

## πŸ–ΌοΈ Screenshots

<div align="center">
<img src="resources/screenshots/main.png" alt="Schermata principale" width="800">
<img src="resources/screenshots/installed.png" alt="Pacchetti installati" width="800">
</div>

## πŸ—οΈ Contributing
Contributions are welcome! Please open an issue or submit a pull request on GitHub.
## 🀝 Contributing

## 🌍 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Contributions are welcome! Please:

1. 🍴 Fork the project
2. πŸ”¨ Create your feature branch
3. πŸ“ Commit your changes
4. πŸš€ Submit a pull request

## πŸ“„ License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## πŸ’– Support

- 🌟 Star the project
- πŸ› [Report a bug](https://github.com/Valkyrie00/bold-brew/issues)
- πŸ’‘ [Propose new features](https://github.com/Valkyrie00/bold-brew/issues)
- πŸ“£ Share the project with your friends

---

<div align="center">
<sub>Built with ❀️ for the community and for all developers</sub>
</div>
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<div class="container">
<img src="bbrew-logo-nobg.png" alt="Bold Brew Logo" class="logo-img">
<h1 class="display-4">Bold Brew</h1>
<p class="lead">An elegant Homebrew TUI manager for macOS</p>
<p class="lead">A simple Homebrew TUI manager for macOS</p>
<div class="badges">
<img src="https://img.shields.io/github/v/release/Valkyrie00/bold-brew" alt="Version">
<img src="https://img.shields.io/github/license/Valkyrie00/bold-brew" alt="License">
Expand Down

0 comments on commit 91021c7

Please sign in to comment.