about summary refs log tree commit diff
diff options
context:
space:
mode:
authorEmile <hanemile@protonmail.com>2019-09-25 14:49:01 +0200
committerEmile <hanemile@protonmail.com>2019-09-25 14:49:01 +0200
commitd0b15e72a8450ba296b5202417eea5463fef89b2 (patch)
treed65b57072d7081ce5261b804699980c883b5c802
parent00b30940a6d447166856979ee3185f1c801f2fa6 (diff)
added some api documentation to the README
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index e7d1fd7..48b1d9c 100644
--- a/README.md
+++ b/README.md
@@ -31,3 +31,13 @@ doesn't need to be downloaded resulting in somwhat faster results.
 
 ![](imgs/out.png)
 
+## Api endpoints
+
+`/`
+index, some examples
+
+`/dumpall`
+manually dump all the TLEs from [celestack](https://celestrak.com/NORAD/elements/) into the `data/` folder.
+
+`/{category}/{name}`
+dump a specific TLE