Skip to content

Commit

Permalink
README.md update
Browse files Browse the repository at this point in the history
Signed-off-by: Navid Yaghoobi <[email protected]>
  • Loading branch information
navidys committed Nov 8, 2023
1 parent f4e0cbf commit 4280849
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 15 deletions.
9 changes: 0 additions & 9 deletions .packit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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 ./"
Expand Down
50 changes: 44 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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": [
Expand Down Expand Up @@ -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)

0 comments on commit 4280849

Please sign in to comment.