Skip to content

Commit 3e09f6f

Browse files
committed
README: Add more Markdown, add link to docs
1 parent 4b3156c commit 3e09f6f

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

NEWS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ WiFiDog 1.2.0:
2626
* Upgrade libhttpd to 1.4 (#91)
2727
* Remove incomplete and broken BSD support (#93)
2828
* Update doc/README.developers.txt (#113)
29+
* Update README (-> README.md) (#114)
2930
* Various other fixes and minor improvements, see
3031
https://github.com/wifidog/wifidog-gateway/compare/1.1.5...1.2.0
3132

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,10 @@ The WiFi Guard Dog project is a complete and embeddable captive portal
44
solution for wireless community groups or individuals who wish to open a
55
free hotspot while still preventing abuse of their Internet connection.
66

7-
The project's homepage is:
8-
http://dev.wifidog.org/
7+
More information and the old issue tracker can be found on
8+
[dev.wifidog.org][homepage].
9+
Nowadays, development happens on [github][GitHub].
910

10-
Development happens on GitHub:
11-
https://github.com/wifidog/
1211

1312
## WifiDog Gateway ##
1413

@@ -22,8 +21,18 @@ embedded hardware, e.g. the hotspot itself. The client is responsible for
2221
redirecting the user to the auth server where they may authenticate
2322
themselves. Depending on the response of the auth server, the client
2423
lifts the access restrictions for the user.
24+
Client and server speak the [WifiDog Protocol Version 1][protov1],
25+
with Version 2 being a draft which has not been implemented so far.
26+
A detailed description of the login process involving user,
27+
client and server is available as a [flow diagram][flowdia].
28+
2529

2630
## License ##
2731
The project's software is released under the GPL license and is copyrighted
2832
by its respective owners. See COPYING for details.
2933

34+
[homepage]: http://dev.wifidog.org/
35+
[github]: https://github.com/wifidog/
36+
[protov1]: http://dev.wifidog.org/wiki/doc/developer/WiFiDogProtocol_V1
37+
[flowdia]: http://dev.wifidog.org/wiki/doc/developer/FlowDiagram
38+

0 commit comments

Comments
 (0)