Skip to content

Commit

Permalink
legacy mode
Browse files Browse the repository at this point in the history
  • Loading branch information
dskvr committed Feb 5, 2024
1 parent 22725b4 commit b78ea7e
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ The `options` object specifies which types of tags to generate.

### Response Options
Please note: that these will only have an effect on the output if the input for their corresponding values were set. This is especially true for passthrough values. Some of these passthrough values may be deduped if they are not unique against ISO values.

- `geohash` (boolean): Includes geohash codes from `ngeohash`, with diminishing resolution, based on latitude and longitude. Default: `true`.
- `city` or `cityName` (boolean): Include a tag for the city in response **if available**. Default: `true`.
- `country` (boolean): Include a tag for the `countryCode` and `countryName` in response **if available**. Default: `true`.
Expand All @@ -89,7 +88,8 @@ Please note: that these will only have an effect on the output if the input for
- `gps` (boolean): Include latitude and longitude as a 'dd' tag (de-factor GPS standards) and separate tags for lat and lon with diminishing resolution. Default: `false`.
- `planet` or `planetName` (boolean): Include a tag for the `planetName` in response **if available**. Default: `false`.


### Compatibility Options
- `legacy` (boolean) Will only return legacy `g` tags, for example: `["g", "u2mwdd"]`

## Response Reference
The function returns an array of tuples, where each tuple represents a tag and its associated data. The format of the tuples is based on `NIP-01`.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"transform"
],
"dependencies": {
"iso-3166": "4.3.0",
"iso-3166": "4.3.1",
"ngeohash": "0.6.3"
},
"scripts": {
Expand Down

0 comments on commit b78ea7e

Please sign in to comment.