pyro-api
pyro-api copied to clipboard
README seems not up to date
Hi there,
Thanks a lot for the recent PR leading to the new data model logic !
I have the feeling that the README is not up to date.
Would it be possible to updates it according to the recent refacto ?
Thanks a lot 🙏
Hey there, mind sharing what's giving you this feeling? 🙏 (apart from the screenshot, and perhaps the very last commit updates on the env variable description in CONTRIBUTING.md, I think it's up to date)
Hehe you are right, it is mainly due to the screenshot :)
Apart for it, I have two questions :
- As long as we need poetry to run main main commands, should python or poetry tool be in Installation/Prerequisites ?
- Also, maybe in the installation section (or somewhere in the readme) you could point to
CONTRIBUTINGfor more explanations on the organisation of the repo and the logic of the api (data model etc) ? In my opinion,CONTRIBUTINGhere is very interesting and not only related to contributing guideline. It's an open question, at the very least, these details are provided, which is the most important point :)