added initial README file

jp-bennett · Jun 7, 2015 · f2602e4 · f2602e4
1 parent 07c47f8
commit f2602e4
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 0 deletions.
diff --git a/README b/README
@@ -0,0 +1 @@
+README.md
diff --git a/README.md b/README.md
@@ -0,0 +1,22 @@
+# fwknop2 - Android Single Packet Authorization Client
+
+## Introduction
+This repository contains the *Fwknop2* client for using Single Packet
+Authorization from Android phones.
+
+![alt text][Fwknop2-startup]
+[Fwknop2-startup]: /doc/Android_fwknop2_startup.png "Fwknop2 Startup"
+
+![alt text][Fwknop2-config]
+[Fwknop2-config]: /doc/Android_fwknop2_config.png "Fwknop2 Configuration"
+
+![alt text][Fwknop2-send-SPA-packet]
+[Fwknop2-send-SPA-packet]: /doc/Android_fwknop2_send_SPA_packet.png "Fwknop2 Send SPA packet"
+
+## License
+*Fwknop2* is released as open source software under the terms of
+the **GNU General Public License (GPL v2)**. The latest release can be found
+at [https://github.com/oneru/Fwknop2/releases](https://github.com/oneru/Fwknop2/releases)
+
+## Contact
+All feature requests and bug fixes are managed through github issues tracking.
diff --git a/doc/Android_fwknop2_config.png b/doc/Android_fwknop2_config.png
diff --git a/doc/Android_fwknop2_send_SPA_packet.png b/doc/Android_fwknop2_send_SPA_packet.png
diff --git a/doc/Android_fwknop2_startup.png b/doc/Android_fwknop2_startup.png