Skip to content

Commit

Permalink
add bootstrapping as JSON notes to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
meeb committed Aug 2, 2024
1 parent 7b55bdf commit c787536
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,15 @@ or
whoisit.load_bootstrap_data(bootstrap_info, overrides=True)
```

Both `whoisit.save_bootstrap_data()` and `whoisit.load_bootstrap_data(some_data)` also
support `as_json=True` as a default argument. The default operation is to return bootstrap
data as a JSON encoded string and load it from a JSON encoded string. If you want to
serialise the bootstrapping information in some other format you can use set `as_json=False` on
both `whoisit.save_bootstrap_data(as_json=False)` and
`whoisit.load_bootstrap_data(some_data, as_json=False)`. These methods will then return and
load a Python dictionary instead of JSON and you can perform serialisation yourself however
you need in your application.

**Important**: when using the overrides you may recieve non-standard data, data that
is not in the same format as officially listed IANA data and you may not recieve a copy
of any required terms of service or terms of use. You will have to manually verify data
Expand Down

0 comments on commit c787536

Please sign in to comment.