@container23/caml-metamask-snap
Version:
CAML AML search metamask Snap
38 lines (21 loc) • 1.41 kB
Markdown
# caml-metamask-snap
A [metamask Snap](https://docs.metamask.io/guide/snaps.html#extend-the-functionality-of-metamask) for the [CAML](https://github.com/container23/caml) search.
*Note: this package is under Alpha version. New breaking changes may be introduced.*
## Getting Started
```shell
yarn install && yarn start
```
## Contributing
### Testing and Linting
Run `yarn test` to run the tests once.
Run `yarn lint` to run the linter, or run `yarn lint:fix` to run the linter and fix any automatically fixable issues.
### Releasing & Publishing
1. Choose a release version.
- Use `npm version`
- The release version should be chosen according to SemVer. Analyze the changes to see whether they include any breaking changes, new features, or deprecations, then choose the appropriate SemVer version. See [the SemVer specification](https://semver.org/) for more information.
2. Build Release Bundle
`yarn build`
3. Publish the release on npm.
- Be very careful to use a clean local environment to publish the release, and follow exactly the same steps used during CI.
- Use `npm publish --dry-run` to examine the release contents to ensure the correct files are included. Compare to previous releases if necessary (e.g. using `https://unpkg.com/browse/[package name]@[package version]/`).
- Once you are confident the release contents are correct, publish the release using `npm publish`.