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-1751 rewrite the readme for go sdk v2 #111

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

Conversation

skyflow-bharti
Copy link
Collaborator

What?
This PR updates the README documentation for Go SDK v2. The new README includes detailed instructions and examples for client initialisation, 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 Go SDK v1 and did not adequately cover the new features and options introduced in v2.

How?

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

@skyflow-bharti skyflow-bharti changed the base branch from main to v2 January 3, 2025 12:30
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