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

update readme to include more useful information #41

Open
nickfrosty opened this issue Nov 19, 2024 · 0 comments · May be fixed by #54
Open

update readme to include more useful information #41

nickfrosty opened this issue Nov 19, 2024 · 0 comments · May be fixed by #54
Labels
documentation Improvements or additions to documentation

Comments

@nickfrosty
Copy link
Member

update the readmes inside this repo to be more useful and include better information about how to use the sdk.

at the very least, the root repo read me and the @solana/actions package readme (they should be mirrored) should be updated with the following:

  • clear link to the typedoc docs: https://solana-developers.github.io/solana-actions/
  • add the npm installs badge at the top
  • example code snippets on the most common functions within this sdk, including (at a minimum):
    • createActionHeaders
    • creating a typed actions.json payload
    • creating a typed get request payload
    • creating a typed post response payload using createPostResponse
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant