diff --git a/README.md b/README.md index 403f086..1d44585 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ -# Danish private flights -This repository contains a CLI application that generates a text based summary of -private jet's flight information targeted to a Danish audience. +# Private jet flights +[![Test](https://github.com/jorgecardleitao/private-jets/actions/workflows/test.yaml/badge.svg)](https://github.com/jorgecardleitao/private-jets/actions/workflows/test.yaml) +[![Coverage](https://codecov.io/gh/jorgecardleitao/private-jets/graph/badge.svg?token=DT7C376OKH)](https://codecov.io/gh/jorgecardleitao/private-jets) + +This repository contains a CLI application to analyze flights of private jets. It is supported by an Azure Blob storage container for caching data, thereby reducing its impact to [https://adsbexchange.com/](https://adsbexchange.com/). @@ -33,8 +35,8 @@ to perform actual calculations. To use one of such examples: 2. run `cargo run --example single_day -- --tail-number "OY-GFS" --date "2023-10-20"` 3. open `OY-GFS_2023-10-20_0.md` -Step 2. has an optional argument, `--azure-sas-token`, specifying an Azure storage container SAS -for account `privatejets`, container `data`. +Step 2. has an optional argument, `--azure-sas-token`, specifying an Azure storage SAS +token. When used, cache is written to the remote container, as opposed to disk. Finally, setting `--backend disk` ignores the Azure's remote storage altogether and