Merge branch 'api-definition' of Satellite/TLE2JSON into master

1 files changed, 32 insertions, 1 deletions

diff --git a/README.md b/README.md
index b119aba..b1eeefd 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,34 @@
 # TLE2JSON
 
-http api returning TLEs as json
\ No newline at end of file
+http api returning TLEs as json
+
+## API
+
+
+### endpoints
+
+The api will eventually consist of the following endpoints. There is currently
+no guarantee that the enpoins will stay like this, this is really early alpha
+and may change alot in the next days / weeks:
+
+- `/v1/getall`
+    - returns all TLEs
+- `/v1/regex/{regex}`
+    - returns all the TLEs matching the given `regex`
+- `/v1/satid/{satid}`
+    - returns all the TLEs with the given `satid`
+- `/v1/category/{category}`
+    - returns all the TLEs from the named category
+    - (the categories are the ones given [here](https://celestrak.com/NORAD/elements/))
+- `/v1/category/{category}/satname/{satname}`
+    - returns the TLE of the satellite in the given `category` with the given
+        `satname`
+
+### parameters
+
+- `?format=json`
+    - returns the TLEs as json objects
+- `?format=raw`
+    - returns the TLE in the raw Two-Line format
+- `?values=inclination,argumentofperigee`
+    - returns the values given as a comma, seperated list of arguments