surrealdb/surrealdb.py

Installation instructions plus other README updates

FrostyTheSouthernSnowman opened this issue · 3 comments

FrostyTheSouthernSnowman commented

Are there any plans to update the README? Some things that I think should be added include:

  • Installation instructions
  • A simple demo for how to use the driver
  • A link to further documentation
  • Maybe a contributing/code of conduct section?
  • Maybe an image/surrealdb logo or something cool at the top (not necessary but kind of cool)

I would be happy to add any or all of the above to the README myself should the owners/maintainer like that.

tsunyoku commented

Hi, thanks for the issue!

There are definitely some valid concerns here. The intention with install instructions/documentation is to keep it all in one place (the surreal website), which is why the README has a link to the website docs (which don't exist - yet!). The repo is still "in development" - while it is published on PyPI and has functionality, things are still being pushed actively and I'm not entirely comfortable moving it out of this state yet.

Image could be cool, we can likely copy it from the main repo. Markdown files for contributing & code of conduct are also something I'll take into consideration. If you're interested in helping with any of these, feel free!

FrostyTheSouthernSnowman commented

Okay. Thanks @tsunyoku. I will get started with the image.

Image could be cool, we can likely copy it from the main repo

Are you referring to this image?

  • 👍1
AlexFrid commented

Thanks for the suggestions ❤️ this has now been updated with the latest PR, therefore closing this issue.