Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Update README.md to be more accurate #102

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

nottisa
Copy link

@nottisa nottisa commented Jun 11, 2024

Thank you for submitting this pull request! We appreciate you spending the time to work on these changes.

What is the motivation?

I needed to quickly start using the Python driver. This documentation is flawed, and I realized I could very quickly fix it. This will save time for other developers like me.

Type of Change

  • Replaced all references to SurrealDB and AsyncSurrealDB with Surreal
  • Added the use function for connecting to namespaces and databases
  • Fixed connection strings to properly reference the /rpc route rather than /database/namespace

What does this change do?

These changes make it easier for people to quickly start writing code with the Surreal Python driver.

@nottisa nottisa changed the title Docs-Update-readme.md-to-be-accurate [Docs] Update README.md to be more accurate Jul 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant