Skip to content

Commit b0bddd1

Browse files
committed
Provide a decent README
1 parent 514b7f1 commit b0bddd1

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

README.md

+19-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,23 @@
1-
# tufw
1+
# Terminal UI for ufw
2+
This go package provides a terminal user interface for `ufw`.
23

3-
A terminal UI for `ufw`
4+
![Screenshot](preview.gif)
5+
6+
It allows you to add, edit or remove rules in a fancy way which is ideal when you're not familiar with `ufw` command.
7+
8+
> Be sure to run it as root otherwise it won't work.
9+
10+
## Installation
11+
```
12+
go install github.com/peltho/tufw@latest
13+
```
14+
15+
## Dependencies
16+
This package is based on [rivo/tview](https://github.com/rivo/tview) (and its dependencies).
17+
18+
## Troubleshooting
19+
Add your issue here on Github if you spot an unwanted behavior.
20+
Feel free to get in touch if you have any questions.
421

522
## Licence
623
[MIT](https://github.com/peltho/tufw/blob/main/LICENSE.txt)

preview.gif

334 KB
Loading

0 commit comments

Comments
 (0)