Skip to content

Commit

Permalink
fix: documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Martin Olivier <[email protected]>
  • Loading branch information
martin-olivier committed Nov 7, 2022
1 parent 73aeb50 commit 0097102
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 6 deletions.
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ authors = ["Martin Olivier <[email protected]>"]
homepage = "https://github.com/martin-olivier/airgorah"
repository = "https://github.com/martin-olivier/airgorah"
documentation = "https://github.com/martin-olivier/airgorah"
description = "A WiFi auditing software that can perform deauth attacks and passwords recovery"
description = "A WiFi auditing software that can perform deauth attacks and passwords cracking"
keywords = ["networking", "pentest", "aircrack-ng", "gui", "linux"]
readme = "README.md"
exclude = ["/.github"]
Expand All @@ -32,7 +32,7 @@ features = ["v4_6"]
copyright = "2022, Martin Olivier"
maintainer = "Martin Olivier <[email protected]>"
license-file = [ "LICENSE" ]
extended-description = "A WiFi auditing software that can perform deauth attacks and passwords recovery"
extended-description = "A WiFi auditing software that can perform deauth attacks and passwords cracking"
depends = "pkexec, libgtk-4-1, dbus-x11, wireless-tools, aircrack-ng (>= 1.6)"
priority = "optional"
section = "utility"
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
</a>
</h1>

<h4 align="center">A WiFi auditing software that can perform deauth attacks and passwords recovery</h4>
<h4 align="center">A WiFi auditing software that can perform deauth attacks and passwords cracking</h4>

<p align="center">
<a href="https://github.com/martin-olivier/airgorah/releases/tag/v0.1.0">
Expand All @@ -23,10 +23,12 @@

![illustration](.github/assets/illustration.png)

`Airgorah` can be used to audit a WiFi network by discovering the clients connected to it, performing deauth attacks against specific clients or all the clients connected to the network, or by recovering the password of the access point.
`Airgorah` can be used to audit a WiFi network by discovering the clients connected to it, performing deauth attacks against specific clients or all the clients connected to the network, or by cracking the password of the access point.

It is written in Rust and uses [GTK4 bindings](https://github.com/gtk-rs/gtk4-rs) for the graphical part. The software is based on [aircrack-ng](https://github.com/aircrack-ng/aircrack-ng) tools suite.

> This project is still in beta version, for the moment only deauth attacks are implemented. The list of future implementations is available [here](#future).
`⭐ Don't forget to put a star if you like the project!`

## Legal
Expand Down
2 changes: 1 addition & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ cargo install airgorah
Then, you will be able to run `airgorah` on your computer by typing the following command:

```sh
sudo airgorah
sudo ~/.cargo/bin/airgorah
```

If you want to uninstall `airgorah` from your computer, enter the following command:
Expand Down
2 changes: 1 addition & 1 deletion src/frontend/interfaces/app.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ fn build_about_button() -> Button {

about_button.connect_clicked(|_| {
let ico = Pixbuf::from_read(std::io::BufReader::new(globals::APP_ICON)).unwrap();
let des = "A WiFi auditing software that can perform deauth attacks and passwords recovery";
let des = "A WiFi auditing software that can perform deauth attacks and passwords cracking";

AboutDialog::builder()
.program_name("Airgorah")
Expand Down

0 comments on commit 0097102

Please sign in to comment.