Skip to content

Commit

Permalink
docs: Add basic usage to README
Browse files Browse the repository at this point in the history
  • Loading branch information
donovanglover committed May 4, 2024
1 parent 2432fdc commit 061b4be
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,26 @@
# new-tab-identity

Web extension to use multiple proxies simultaneously with multi-account containers in Firefox-based browsers.
Browse the web from multiple VPN locations simultaneously. Goes well with [Librewolf](https://librewolf.net/).

## Features

- Open new container tabs with different VPN locations.
- Visit the same website with different VPN locations.

### Supported Providers

- [Mullvad VPN](https://mullvad.net)

## Installation

1. `git clone https://github.com/donovanglover/new-tab-identity && cd new-tab-identity`
2. `npm ci && npm run build`
3. Go to `about:addons`, press the gear icon on the right and press "Install Add-on From File..."

## Usage

Use the extension popup to create new identities and delete old ones.

## Contributing

Run `npm ci` to do a clean install and use the `lint` and `test` scripts to check your work.

0 comments on commit 061b4be

Please sign in to comment.