diff options
author | Emile <hanemile@protonmail.com> | 2019-09-23 13:15:38 +0200 |
---|---|---|
committer | Emile <hanemile@protonmail.com> | 2019-09-23 13:15:38 +0200 |
commit | a0d950848d3699e72bc267639bfd6400bc38d7e1 (patch) | |
tree | f13c94a462f82615bc65c453b73ef3cfe3ce8aff | |
parent | 867ca7d89b990750d876537375e8b471fcf1db6b (diff) |
updated the README
added a section describing how to populate the cache
-rw-r--r-- | README.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md index 8fee107..677c2a9 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ http api returning TLEs as json ## Setup +### Run the server + standalone: `go run . -p <port>` @@ -15,6 +17,12 @@ $ docker build . -t tle2json $ docker run -p <port extern>:8080 tle2json ``` +### Populate the cache + +By accessing the `/dumpall` endpoint, you can download all the TLEs populating +the cache. The next time the file containing the TLE needs to be accessed, it +doesn't need to be downloaded resulting in somwhat faster results. + ![](imgs/out.png) ## API |