chore: improve README.md standardization

smcclellan commented 1 year ago

This PR was published to npm with the alpha versions:

connect npm install @stacks/connect@7.3.2-alpha.961215c.0 --save-exact

connect-react npm install @stacks/connect-react@22.1.2-alpha.961215c.0 --save-exact

connect-ui npm install @stacks/connect-ui@6.1.2-alpha.961215c.0 --save-exact

Use the following template to create your pull request

Description

Describe the changes that where made in this pull request. When possible start with a user story - short, simple descriptions of a feature told from the perspective of the person who desires the new capability. Be sure to also include the following information:

Motivation for change
What was changed
How does this impact application developers
Link to relevant issues and documentation
Provide examples of use cases with code samples and applicable acceptance criteria

Example: As a Blockstack developer, I would like to encrypt files using the app private key. This is needed because storing unencrypted files is unacceptable. This pull request adds the encryptContent function which will take a string and encrypt it using the app private key.

encryptContent('my data')

// Running the above should result in the following encrypted data object
{"iv":"c91...","ephemeralPK":"031...","cipherText":"d61...","mac":"e73..."}

For details refer to issue #123

Type of Change

[ ] New feature
[ ] Bug fix
[ ] API reference/documentation update
[ ] Other

Does this introduce a breaking change?

List the APIs or describe the functionality that this PR breaks. Workarounds for or expected timeline for deprecation

Are documentation updates required?

[ ] Link to documentation updates:

Testing information

Provide context on how tests should be performed.

Is testing required for this change?
If it’s a bug fix, list steps to reproduce the bug
Briefly mention affected code paths
List other affected projects if possible
Things to watch out for when testing

Checklist

[ ] Code is commented where needed
[ ] Unit test coverage for new or modified code paths
[ ] yarn lerna run test passes
[ ] Changelog is updated
[ ] Tag 1 of @hstove or @kyranjamie or @aulneau for review

changeset-bot[bot] commented 1 year ago

⚠️ No Changeset found

Latest commit: 961215c99bce9b30b69497c0d0ab2bc3cd3d267f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR