Skip to content

Commit c86cdb6

Browse files
authored
Rebrand RABBIT to RABBIT-ng in README
Updated README to reflect rebranding from RABBIT to RABBIT-ng, including changes in installation instructions and tool references.
1 parent 4461df5 commit c86cdb6

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,13 @@
1212

1313

1414
[![Python Version](https://img.shields.io/badge/python-3.11%20|%203.12%20|%203.13-blue)](https://pypi.org/project/rabbit/)
15-
# RABBIT - Activity-Based Bot Identification Tool
15+
# RABBIT is an Activity-Based Bot Identification Tool
1616
</div>
1717

1818
---
1919

20+
**Notice:** RABBIT is rebranded as **RABBIT-ng**, partly to reflect its revamped CLI interface and improved internal code structure, and partly to address a name collision on PyPI.
21+
2022
## Overview
2123

2224
**RABBIT** is a machine-learning based tool designed to identify bot accounts among GitHub contributors.
@@ -56,10 +58,10 @@ it can predict **thousands of accounts per hour** without reaching GitHub's impo
5658

5759
### Installation
5860

59-
> RABBIT requires at least **Python 3.11**.
61+
RABBIT-ng requires at least **Python 3.11**.
6062

6163
#### Option A: Using [uv](https://docs.astral.sh/uv/)
62-
This installs RABBIT in an isolated environment, keeping your system clean.
64+
This installs RABBIT-ng in an isolated environment, keeping your system clean.
6365
You can find more details on how to install `uv` in its [official documentation](https://docs.astral.sh/uv/getting-started/installation).
6466
```shell
6567
$ uv tool install rabbit-ng
@@ -76,9 +78,9 @@ $ pip install rabbit-ng
7678
```
7779

7880
#### Option C: Using Nix
79-
RABBIT is also available via [Nix](https://search.nixos.org/packages?channel=unstable&show=rabbit&from=0&size=50&sort=relevance&type=packages&query=rabbit)
81+
RABBIT is also available via [Nix](https://search.nixos.org/packages?channel=unstable&type=packages&query=rabbit-ng)
8082
```shell
81-
$ nix-shell -p rabbit
83+
$ nix-shell -p rabbit-ng
8284
```
8385

8486
### Configuration (API Key)

0 commit comments

Comments
 (0)