Commit 70f8b46d authored by Serverket's avatar Serverket

New README (includes LICENSE update).

parent b7add9d8
Pipeline #1237 failed with stages
This diff is collapsed.
This diff is collapsed.
# AnonSurf · [![Project license](https://img.shields.io/badge/license-GPLv3-blue)](/LICENSE) [![Project release](https://img.shields.io/badge/release-3.0.5-green)](/LICENSE)
Anonymous Toolkit for Parrot OS.
## :camera: Screenshots
| Running | Boot | Stats | Credits |
|---|---|---|---|
| ![Running screen](https://user-images.githubusercontent.com/67027339/93720158-ccdd7680-fb76-11ea-936e-d4177fede2aa.png) | ![Boot screen](https://user-images.githubusercontent.com/67027339/93720159-d23ac100-fb76-11ea-8074-165ee6957ccf.png) | ![Stats screen](https://user-images.githubusercontent.com/67027339/93720162-d666de80-fb76-11ea-84b2-47ba359c78b3.png) | ![Credits screen](https://user-images.githubusercontent.com/67027339/93720165-dc5cbf80-fb76-11ea-96a7-f0ce0683e863.png)
**The images are only for demonstration purpose, Please don't use those images.**
## :gear: Installation
The commands below will make you able to create a build for both CLI and GTK versions of AnonSurf.
1. Clone the repo to get the latest working version.
Example using SSH:
```
git clone git@git.parrotsec.org:packages/tools/anonsurf.git
```
2. Install Gintro (GTK bindings for Nim):
```
apt install libnim-gintro-dev
```
3. Create Debian's binaries (CLI and GTK) for installation:
```
debuild -us -uc -b
```
## :memo: Notes
* You'll find the binaries inside the project's root folder, use ```dpkg -i PACKAGE.deb``` to install them.
* **Do not run AnonSurf as root.**
## :information_source: Main features
* **Fast**: AnonSurf it's made on Nim, it uses less than 1% of memory.
* **Easy**: You can Start, Stop and Restart AnonSurf easily from both CLI or GTK interface.
* **Safe**: ID can be changed by restarting or switching Tor nodes.
* **Realiable**: You can check the public IP address or the Tor status using Nyx.
* **Configurable**: AnonSurf can be enabled or disbled at boot (as system service).
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment