From 4280849796230db6756f485e1b5a3b301eef7b15 Mon Sep 17 00:00:00 2001 From: Navid Yaghoobi Date: Wed, 8 Nov 2023 20:51:42 +1100 Subject: [PATCH] README.md update Signed-off-by: Navid Yaghoobi --- .packit.yaml | 9 --------- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++------ 2 files changed, 44 insertions(+), 15 deletions(-) diff --git a/.packit.yaml b/.packit.yaml index d201ed2..4a0fa4f 100644 --- a/.packit.yaml +++ b/.packit.yaml @@ -14,15 +14,6 @@ jobs: - make - openssl-devel - rpkg - targets: - - fedora-all-x86_64 - - fedora-all-aarch64 - - fedora-all-ppc64le - - fedora-all-s390x - - centos-stream-9-x86_64 - - centos-stream-9-aarch64 - - centos-stream-9-ppc64le - - centos-stream-9-s390x actions: post-upstream-clone: - "rpkg spec --outdir ./" diff --git a/README.md b/README.md index 94db2b9..1bbdd4a 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,9 @@ A `gopensky` binary command line is also available to query the opensky network ## gopensky module +visit [Golang OpenSky Network API](https://navidys.github.io/gopensky/) for more examples. + + ``` import ( "context" @@ -46,16 +49,49 @@ func main() { ## gopensky cmd -### build +### Installation + +* From source: + + ``` + $ make binary + ``` + +* RPM package (COPR upstream build): + + ``` + $ sudo dnf copr enable navidys/gopensky + $ sudo install gopensky + ``` + +### Usage ``` -$ make binary +$ gopensky -h +Query opensky network live API information (ADS-B and Mode S data) + +Usage: + gopensky [flags] + gopensky [command] + +Available Commands: + arrivals Retrieve flights for a certain airport which arrived within a given time interval + help Help about any command + states retrieve state vector information + +Flags: + -d, --debug run in debug mode + -h, --help help for gopensky + -j, --json print json output + -u, --username string connection username + -v, --version print version and exit + ``` -### json output +#### Example get states (json output) ``` -$ ./bin/gopensky states -j +$ gopensky states -j { "time": 1699160183, "states": [ @@ -86,9 +122,11 @@ $ ./bin/gopensky states -j } ``` -### table output +#### Example get states (table output) + + ``` -$ ./bin/gopensky states +$ gopensky states ``` ![Screenshot](./docs/_static/gopensky-query.png)