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

SK-1749: Updated README.md for python SDK v2 #134

Merged
merged 17 commits into from
Nov 21, 2024

Conversation

saileshwar-skyflow
Copy link
Collaborator

@saileshwar-skyflow saileshwar-skyflow commented Nov 19, 2024

What?
This PR updates the README documentation for Python SDK v2. The new README includes detailed instructions and examples for client initialization, configuration options, and vault api usage. It reflects the enhanced flexibility, modularity, and best practices implemented in SDK v2.

Why?
The previous README was tailored for Python SDK v1 and did not adequately cover the new features and options introduced in v2.

How?

  • Updated the README to showcase examples of initializing clients with different configurations and vault api usage.
  • Ensured the README aligns with Pythonic principles adopted in SDK v2, including modularity and clarity.
  • Simplified complex scenarios with step-by-step instructions and relevant code snippets.

@saileshwar-skyflow saileshwar-skyflow merged commit 847973b into release/24.11.1 Nov 21, 2024
4 checks passed
@saileshwar-skyflow saileshwar-skyflow deleted the SK-1749-readme branch November 26, 2024 12:49
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.

2 participants