write a readme

[PietrH]

Ideally we'd also add a vignette on how to use the package, but this is something for beyond v0.1.

Things to mention in the readme:

• [ ] Why did we make this package, mention that we want it to be broadly applicable for all iAsset users, but that our focus is currently on Vespa-Watch and RIPARIAS
• [ ] What is the scope of the package (currently reading records, not changing them)
• [ ] Refer to the iAsset API documentation
• [ ] What can you do with the package; functions; get_access_token() for a token, get_records() to get records and get_fields() to get information about the fields
• [ ] (optional) Mention Vespa-Watch as funding?
• [ ] An example (excluding passwords, usernames or keys!) or how to get records out of iAsset

[PietrH]

@SanderDevisscher Would you be willing to tackle this?

[PietrH]

I think the basic example could be something like;

# You need an access token to talk to the iAsset API. You can reuse this token
# over multiple requests, but you need to request a new one at least once every
# 24 hours.
my_token <- get_access_token("my_username")
# By default the package will only look on the `riparias` domain, and only for
# the `Vespa-Watch` custom inspection. If you don't provide an access token, the
# package will try to create one.
get_records(inspection_name = "Vespa-Watch", access_token = my_token)

It would be great if we could include a few rows of output as well, but we'd need to be really careful on what data we put in there.