1
0
mirror of https://github.com/bettercap/bettercap.git synced 2025-03-12 04:36:03 -07:00

docs: improved readme

This commit is contained in:
evilsocket 2018-01-27 17:58:40 +01:00
parent ef69f4ae67
commit 3ada037887

@ -12,9 +12,9 @@
---
This is a WIP of the new version of [bettercap](https://github.com/evilsocket/bettercap), very alpha, **do not use** ... or do, whatever.
**bettercap-ng** is a complete reimplementation of bettercap, the Swiss army knife for MITM and network attacks. It is faster, stabler, smaller, easier to install and to use.
## Docker
## Using with Docker
In this repository, BetterCAP is containerized using [Alpine Linux](https://alpinelinux.org/ "") - a security-oriented, lightweight Linux distribution based on musl libc and busybox. The resulting Docker image is relatively small and easy to manage the dependencies.
@ -72,6 +72,10 @@ As an example, let's cross compile bettercap for ARM (requires `gcc-arm-linux-gn
**Done**
## Interactive Mode
By default, bettercap-ng will start in interactive mode, allowing you to start and stop modules manually, change options and apply new firewall rules on the fly, to show the help menu type `help`, you can have module specific help by using `help module-name`.
## Caplets
Interactive sessions can be scripted with `.cap` files, or `caplets`, the following are a few basic examples, look the `caplets` folder for more.
@ -247,10 +251,6 @@ function onResponse(req, res) {
}
```
## Interactive Mode
Interactive mode allows you to start and stop modules manually on the fly, change options and apply new firewall rules on the fly, to show the help menu type `help`, you can have module specific help by using `help module-name`.
## License
`bettercap` and `bettercap-ng` are made with ♥ by [Simone Margaritelli](https://www.evilsocket.net/) and they're released under the GPL 3 license.