add general project files

Change-Id: I3cbfc7f17c61ea9c562382240b304ff46ba62ef3
---
A README.md
A TODO.md
2 files changed, 75 insertions(+), 0 deletions(-)


git pull ssh://gerrit.osmocom.org:29418/erlang/osmo-epdg refs/changes/22/34722/1

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6f93fed
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+= osmo-ePDG =
+
+Implement an ePDG with an embedded AAA server.
+osmo-ePDG also requires a modify strongswan.
+
+* [UE] <-> [strongswan] <-> [osmo-ePDG] <> [HSS]
+                                        <> [PGW]
+
+== Building ==
+
+Install erlang and rebar3 packages (not "rebar", that's version 2! You may need
+to compile it from source in some distros).
+
+$ rebar3 compile
+$ rebar3 escriptize
+
+== Testing ==
+
+Unit tests can be run this way:
+$ rebar3 eunit
+
+== Running ==
+
+Once osmo\_epdg is built, you can start it this way:
+
+$ rebar3 shell
+
+In the erlang shell:
+```
+1> osmo_epdg:start().
+```
+
+== Configuration ==
+
+$ rebar3 shell --config ./examples/sys.config
+```
+1> osmo_epdg:start().
+```
+
diff --git a/TODO.md b/TODO.md
new file mode 100644
index 0000000..b4a1e7c
--- /dev/null
+++ b/TODO.md
@@ -0,0 +1,27 @@
+# TODO
+
+- introduce a gen_fsm to hold all the state
+- async calls (e.g. terminate subscription)
+- improve and understand the supervisor
+ - when the gsup_server dies, it should only restart the gsup_server
+ - same for epdg_diameter_swx
+
+- linting for erlang?
+
+## upstream dependencies
+
+### wireshark
+
+- add message class 5 -> IPSEC_EPDG
+
+### libosmocore
+
+- upstream message class
+
+### osmo_ss7
+
+- upstream changes
+
+### osmo_gsup
+
+- upstream changes

