From d0b15e72a8450ba296b5202417eea5463fef89b2 Mon Sep 17 00:00:00 2001
From: Emile <hanemile@protonmail.com>
Date: Wed, 25 Sep 2019 14:49:01 +0200
Subject: added some api documentation to the README

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

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
-- 
cgit 1.4.1