better documentation

[pve-firewall.git] / README

diff --git a/README b/README
index 03d2d2c7e7b880041805a67b12da4929cdb1eef9..b9a9da7a08ddba0a46b5706355734b09d4faae60 100644 (file)
--- a/README
+++ b/README
@@ -1 +1,13 @@
-Experimental software, only used for testing
\ No newline at end of file
+Experimental software, only used for testing.
+
+VM firewall rules are read from /etc/pve/firewall/<VMID>.fw
+
+You can find examples in the example/ dir
+
+Use the following command to generate shorewall configuration:
+
+./pvefw compile
+
+That command overwrites /etc/shorewall/, so don't use if you have
+and existing shorewall config you want to keep.
+