search

unitaryfund / metriq-api

RESTful API for Metriq
https://metriq.info
Apache License 2.0
4 stars 8 forks source link

Update Readme #215

Closed nathanshammah closed 1 year ago

nathanshammah commented 1 year ago

Update Readme with information from the qedc folder.

vprusso commented 1 year ago

Hmm. I wonder if we should keep the README file for the root metriq-api project relatively lean. As the benchmark/ component is fairly separate and also has its own self-contained README file (here).

I would opt to keep the separation, but I'm open to opposition. Thoughts @WrathfulSpatula , @nathanshammah ?

WrathfulSpatula commented 1 year ago

I think your stance on this makes sense, @vprusso. I don't know if @nathanshammah has more to say, but I would defer to you.

WrathfulSpatula commented 1 year ago

Maybe we could link the secondary README in the main README?

vprusso commented 1 year ago

Addressed in https://github.com/unitaryfund/metriq-api/pull/217