diff --git a/README.md b/README.md index e2ff413..db24feb 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,18 @@ # Captive Portal -This is supposed to be a captive portal webpage. - Work in progress right now. +Captive portal webpage written with simplicity in mind. + + - Present a webpage to the user + - Users submits a form + - Plugins are executed with form data + - User is granted access to whatever treasure the portal is guarding + +This is a commonly seen setup in public Wifi networks or hotspots. + +This app was specifically written for such a hotspot and as such requires a lot of other configuration around it. This is an ongoing [documentation project here](http://wiki.sydit.se/teknik:guider:captive_portal_med_iptables). + # Plugins Plugins are executed when the user clicks through the captive portal form, whether they submit data or just approve an EULA these plugins are executed.