Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
thewh1teagle committed May 6, 2024
1 parent bde835d commit 837cac0
Showing 1 changed file with 22 additions and 25 deletions.
47 changes: 22 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,25 @@

Load cookies from any browser on any platform

## Install βš™οΈ
## Features πŸš€

- Available for `Rust`, `Python`, and `JavaScript`
- Ensures type safety (e.g., `TypeScript`, `Python` with type hints)
- Fast, written in `Rust`
- Bypass `Chrome` restriction like file locking
- Read session cookies from `Chrome` based browsers! (requires admin rights on `Windows`)
- Wide browsers support
- Cross-platform support for `Windows`, `Linux`, and `macOS`

## Usage βš™οΈ

## Rust

```shell
cargo add rookie
```

## Usage

Create `main.rs` with the following
```rust
use rookie::brave;

Expand All @@ -28,17 +39,13 @@ fn main() {
}
```

## Bindings πŸ“š

There's `Python` and `JavaScript` bindings for rookie!

## Python

```shell
pip install rookiepy
```

And the usage it similar to original
And the usage it similar to Rust

```python
import rookiepy
Expand All @@ -63,14 +70,19 @@ for (const cookie of cookies) {

## Examples πŸ“‹

`Rust` [examples/rust](examples/rust)

`Python` [examples/python](examples/python)

`JavaScript` [examples/javascript](examples/javascript)

`Rust` [examples/rust](examples/rust)

## Docs πŸ“˜

`Rust`

- [docs/Rust.md](docs/Rust.md)
- [docs.rs/rookie](https://docs.rs/rookie)

`Python`

- [docs/Python.md](docs/Python.md)
Expand All @@ -79,21 +91,6 @@ for (const cookie of cookies) {

- [docs/JavaScript.md](docs/JavaScript.md)

`Rust`

- [docs/Rust.md](docs/Rust.md)
- [docs.rs/rookie](https://docs.rs/rookie)

## Features πŸš€

- Fast, written in `Rust`
- Bypass `Chrome` restriction like file locking
- Read session cookies from `Chrome` based browsers! (`Windows`)
- Wide browsers support
- Cross-platform support for `Windows`, `Linux`, and `macOS`
- Available for `Rust`, `Python`, and `JavaScript`
- Ensures type safety (e.g., `TypeScript`, `Python` with type hints)

## CLI πŸ’»

You can use rookie as a `CLI` tool which will decrypt the cookies and print it as `JSON`
Expand Down

0 comments on commit 837cac0

Please sign in to comment.