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 with migration guide and more relevant tutorial #618

Merged
merged 1 commit into from
Jul 10, 2023

Conversation

JST5000
Copy link
Collaborator

@JST5000 JST5000 commented Jul 10, 2023

High Level Overview of Change

Updating the README to be easier to read + get started from. Also added a link to the migration guide in case it's helpful for discovering what to do.

Context of Change

When adding the migration guide I noticed the first example code snippet was hard to use, so replaced it with code from the submit_a_payment.py code snippet with a few comment updates.

Type of Change

  • Documentation Updates

Test Plan

CI Passes

Copy link
Collaborator

@jonathanlei jonathanlei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ckniffen ckniffen merged commit d586617 into master Jul 10, 2023
17 checks passed
@ckniffen ckniffen deleted the update-readme branch July 10, 2023 22:09
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.

None yet

3 participants