unitaryfund / metriq-client

Fork of papers-with-code client
https://metriq.info
Apache License 2.0
3 stars 9 forks source link

Documentation: Include additional examples in README for usage #84

Closed vprusso closed 1 year ago

vprusso commented 1 year ago

Right now, the main project README just has a proof-of-concept example that sets up the API token and ensures that the "metriq_hello" endpoint can be hit.

We should include more involved usage examples. One possible approach would be to include subheadings with labels like "Platforms", "Tags", "Tasks", etc. where under each of these subheadings there are some basic "action" items that can be invoked (update, add, delete, etc.).

This does not need to be exhaustive, but it would be nice to include more detailed examples than just the hello route.

vprusso commented 1 year ago

Closed from https://github.com/unitaryfund/metriq-client/pull/102