Skip to content

Update readme to reflect new options #44

@jsejcksn

Description

@jsejcksn

@fulldecent It looks like lines 9 to 79 in the readme didn't get updated in the latest release; it still shows the outdated options information:

## Usage
```sh
CoreLocationCLI -h
CoreLocationCLI [-follow] [-verbose] [-format FORMAT]
CoreLocationCLI [-follow] [-verbose] -json
```
| Switch | Description |
| ---------------- | ------------------------------------------------------ |
| `-h` | Display this help message and exit |
| `-follow` | Continually print location |
| `-verbose` | Show debugging output |
| `-format FORMAT` | Print a formatted string with the following specifiers |
| `-json` | JSON output mode |
| Format | Description |
| -------------- | ---------------------------------------- |
| `%latitude` | Latitude (degrees north; or negative for south) |
| `%longitude` | Longitude (degrees west; or negative for east) |
| `%altitude` | Altitude (meters) |
| `%direction` | Degrees from true north |
| `%speed` | Meters per second |
| `%h_accuracy` | Horizontal accuracy (meters) |
| `%v_accuracy` | Vertical accuracy (meters) |
| `%time` | Time |
| `%address` | Reverse geocoded location to an address |
| `%name` | Reverse geocoded place name |
| `%isoCountryCode` | Reverse geocoded ISO country code |
| `%country` | Reverse geocoded country name |
| `%postalCode` | Reverse geocoded postal code |
| `%administrativeArea` | Reverse geocoded state or province |
| `%subAdministrativeArea` | additional administrative area information |
| `%locality` | Reverse geocoded city name |
| `%subLocality` | additional city-level information |
| `%thoroughfare` | Reverse geocoded street address |
| `%subThoroughfare` | additional street-level information |
| `%region` | Reverse geocoded geographic region |
| `%timeZone` | Reverse geocoded time zone |
| `%time_local` | Localized time using reverse geocoded time zone |
The default format is: `%latitude %longitude`.
## Output examples
```sh
./CoreLocationCLI
```
> ```
> 50.943829 6.941043
> ```
```sh
./CoreLocationCLI -format "%latitude %longitude\n%address"
```
> ```
> 50.943829 6.941043
> Kaiser-Wilhelm-Ring 21
> Cologne North Rhine-Westphalia 50672
> Germany
> ```
```sh
./CoreLocationCLI -json
```
>```json
>{"address":"407 Keats Rd\nLower Moreland PA 19006\nUnited States","locality":"nLower Moreland","subThoroughfare":"407","time":"2019-10-03 04:10:05 +0000","subLocality":null,"administrativeArea":"PA","country":"United States","thoroughfare":"Keats Rd","region":"<+40.141196,-75.034815> radius 35.91","speed":"-1","latitude":"40.141196","name":"1354 Panther Rd","altitude":"92.00","timeZone":"America\/New_York","time_local": "2019-10-02 23:10:05 -0400","isoCountryCode":"US","longitude":"-75.034815","v_accuracy":"65","postalCode":"19006","direction":"-1.0","h_accuracy":"65","subAdministrativeArea":"Montgomery"}
> ```

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions