Commit
+94 -1 +/-1 browse
| 1 | diff --git a/README.md b/README.md |
| 2 | index c8bee4c..d8559ce 100644 |
| 3 | --- a/README.md |
| 4 | +++ b/README.md |
| 5 | @@ -1 +1,94 @@ |
| 6 | - # Flights ✈️ |
| 7 | + # ✈️ Flights ✈️ |
| 8 | + |
| 9 | + `flights` is a program that helps you _Find The Best Possible Flight_. |
| 10 | + |
| 11 | + |
| 12 | + ## Usage |
| 13 | + |
| 14 | + ``` |
| 15 | + Usage: flights COMMAND [arg...] |
| 16 | + |
| 17 | + ✈️ Find The Best Possible Flight ✈️ |
| 18 | + |
| 19 | + Commands: |
| 20 | + airports list all possible airports |
| 21 | + routes list all possible routes |
| 22 | + furthest show the furthest distance you can travel |
| 23 | + nearby show airports nearby |
| 24 | + route find the best possible routes |
| 25 | + |
| 26 | + ``` |
| 27 | + |
| 28 | + ### airports |
| 29 | + |
| 30 | + List all known airports |
| 31 | + |
| 32 | + #### Example |
| 33 | + |
| 34 | + ``` |
| 35 | + $ flights airports |
| 36 | + 1Z8:ENIWETOK ISLAND:MARSHALL ISLANDS |
| 37 | + AAA:ANAA:FRENCH POLYNESIA |
| 38 | + AAE:ANNABA:ALGERIA |
| 39 | + AAH:AACHEN:GERMANY |
| 40 | + AAL:AALBORG:DENMARK |
| 41 | + ... |
| 42 | + ZVA:MIANDRIVAZO:MADAGASCAR |
| 43 | + ZVK:SAVANNAKHET:LAOS |
| 44 | + ZWA:ANDAPA:MADAGASCAR |
| 45 | + ZYL:SYLHET OSMANI:BANGLADESH |
| 46 | + ZZU:MZUZU:MALAWI |
| 47 | + ``` |
| 48 | + |
| 49 | + ### routes |
| 50 | + |
| 51 | + List all possible routes |
| 52 | + |
| 53 | + ``` |
| 54 | + $ flights routes |
| 55 | + AER:SOCHI:RUSSIA->KZN:KAZAN:RUSSIA |
| 56 | + ASF:ASTRAKHAN:RUSSIA->KZN:KAZAN:RUSSIA |
| 57 | + ASF:ASTRAKHAN:RUSSIA->MRV:MINERALNYE VODY:RUSSIA |
| 58 | + CEK:CHELYABINSK:RUSSIA->KZN:KAZAN:RUSSIA |
| 59 | + KZN:KAZAN:RUSSIA->AER:SOCHI:RUSSIA |
| 60 | + ... |
| 61 | + TSV:TOWNSVILLE:AUSTRALIA->ISA:MOUNT ISA:AUSTRALIA |
| 62 | + WGA:WAGGA WAGGA:AUSTRALIA->MEL:MELBOURNE:AUSTRALIA |
| 63 | + WGA:WAGGA WAGGA:AUSTRALIA->SYD:SYDNEY:AUSTRALIA |
| 64 | + FRU:BISHKEK:RUSSIA->OSS:OSH:RUSSIA |
| 65 | + OSS:OSH:RUSSIA->FRU:BISHKEK:RUSSIA |
| 66 | + ``` |
| 67 | + |
| 68 | + ### furthest |
| 69 | + |
| 70 | + Show the furthest distance you can travel to |
| 71 | + |
| 72 | + ``` |
| 73 | + $ flights furthest ORD |
| 74 | + 17635.263685:ORD:CHICAGO:USA-->JAD:PERTH:AUSTRALIA |
| 75 | + ``` |
| 76 | + |
| 77 | + ### nearby |
| 78 | + |
| 79 | + Show nearby airports |
| 80 | + |
| 81 | + ``` |
| 82 | + $ flights nearby -t 100 ORD |
| 83 | + 29.587434:ORD:CHICAGO:USA-->DPA:WEST CHICAGO:USA |
| 84 | + 49.317547:ORD:CHICAGO:USA-->UGN:CHICAGO:USA |
| 85 | + 24.862137:ORD:CHICAGO:USA-->MDW:CHICAGO:USA |
| 86 | + ``` |
| 87 | + |
| 88 | + ### route |
| 89 | + |
| 90 | + Show the quickest possible route |
| 91 | + |
| 92 | + ``` |
| 93 | + $ flights route ORD LIM |
| 94 | + 6108.125430:ORD:CHICAGO:USA-->PTY:PANAMA CITY:PANAMA-->LIM:LIMA:PERU |
| 95 | + ``` |
| 96 | + |
| 97 | + ## TODO |
| 98 | + |
| 99 | + * loadable data structure that contains pricing data |
| 100 | + * ...?? |