diff --git a/plugins/ufw/README.md b/plugins/ufw/README.md new file mode 100644 index 000000000..ac377cd17 --- /dev/null +++ b/plugins/ufw/README.md @@ -0,0 +1,18 @@ +# UFW plugin + +This plugin adds completion for managing everybody's favorite Uncomplicated Firewall (UFW), +a simple interface for managing iptables. Learn more about [`UFW`](https://wiki.ubuntu.com/UncomplicatedFirewall). + +To use it, add ufw to the plugins array of your zshrc file: +``` +plugins=(... ufw) +``` + +Some of the commands include: + +* `allow /` add an allow rule +* `default` set default policy +* `delete /` delete RULE +* `deny /` add deny rule +* `disable` disables the firewall +* `enable` enables the firewall