diff --git a/README.md b/README.md index 7f82184..76aa52e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # TLE API -[![build](https://travis-ci.com/ivanstan/tle-api.svg?branch=master)](https://travis-ci.com/ivanstan/tle-api) + + ![coverage](https://badgen.net/coveralls/c/github/ivanstan/tle-api) -![dependabot](https://badgen.net/dependabot/dependabot/dependabot-core/?icon=dependabot) ![status](https://badgen.net/uptime-robot/status/m781499721-d42767e28cc71aea507fb087) ![status](https://badgen.net/uptime-robot/month/m781499721-d42767e28cc71aea507fb087) ![status](https://badgen.net/uptime-robot/response/m781499721-d42767e28cc71aea507fb087) @@ -14,20 +14,18 @@ API provides up to date two line element set records, the data is updated daily from [CelesTrak](https://celestrak.com/) and served in JSON format. A two-line element set (TLE) is a data format encoding a list of orbital elements of an Earth-orbiting object for a given point in time. -For more information on TLE data format visit [Definition of -Two-line Element Set Coordinate System](https://spaceflight.nasa.gov/realdata/sightings/SSapplications/Post/JavaSSOP/SSOP_Help/tle_def.html). ## Usage Further documentation and response examples are available at: -http://tle.ivanstanojevic.me/api/tle/docs +https://tle.ivanstanojevic.me/ -###Available endpoints +### Available endpoints The TLE API consists of two endpoints `GET http://tle.ivanstanojevic.me` | Endpoint | Description | |----------|:------:| -| `GET /api/tle?search={q}` | Perform search by satellite name | -| `GET /api/tle/{q}` | Retrieve a single TLE record where query is satellite number | +| `GET /api/tle?search={query}` | Perform search by satellite name | +| `GET /api/tle/{id}` | Retrieve a single TLE record where id is satellite number | Example query http://tle.ivanstanojevic.me/api/tle