Skip to content

Tweak the README #198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
davep merged 2 commits into from
Feb 3, 2026
Merged

Tweak the README #198

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f3eebf
:books: Stop suggesting Homebrew
davep Feb 3, 2026
ba7e3ee
:books: Add bling to the README
davep Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

![Braindrop](https://raw.githubusercontent.com/davep/braindrop/refs/heads/main/.images/braindrop-social-banner.png)

[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/davep/braindrop/style-lint-and-test.yaml)](https://github.com/davep/braindrop/actions)
[![GitHub commits since latest release](https://img.shields.io/github/commits-since/davep/braindrop/latest)](https://github.com/davep/braindrop/commits/main/)
[![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/davep/braindrop)](https://github.com/davep/braindrop/issues)
[![GitHub Release Date](https://img.shields.io/github/release-date/davep/braindrop)](https://github.com/davep/braindrop/releases)
[![PyPI - License](https://img.shields.io/pypi/l/braindrop)](https://github.com/davep/braindrop/blob/main/LICENSE)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/braindrop)](https://github.com/davep/braindrop/blob/main/pyproject.toml)
[![PyPI - Version](https://img.shields.io/pypi/v/braindrop)](https://pypi.org/project/braindrop/)

## Introduction

Braindrop is a terminal-based client application for the [raindrop.io
Expand Down Expand Up @@ -41,13 +49,17 @@ The package can be install using [`uv`](https://docs.astral.sh/uv/getting-starte
uv tool install --python 3.13 braindrop
```

### Homebrew
If you don't have `uv` installed you can use [uvx.sh](https://uvx.sh) to
perform the installation. For GNU/Linux or macOS or similar:

```sh
curl -LsSf uvx.sh/braindrop/install.sh | sh
```

The package is available via Homebrew. Use the following commands to install:
or on Windows:

```sh
$ brew tap davep/homebrew
$ brew install braindrop
powershell -ExecutionPolicy ByPass -c "irm https://uvx.sh/braindrop/install.ps1 | iex"
```

Once installed run the `braindrop` command.
Expand Down