Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flyq/motoko-sha224
https://github.com/flyq/motoko-sha224
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/flyq/motoko-sha224
- Owner: flyq
- License: apache-2.0
- Created: 2021-05-21T04:58:30.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-23T07:01:06.000Z (almost 1 year ago)
- Last Synced: 2024-11-14T06:34:47.547Z (about 1 month ago)
- Language: Motoko
- Size: 23.4 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-motoko - motoko-sha224 - A Sha224 implements for Motoko. (Libraries / Cryptography)
README
# motoko-library-template
A template for making a Motoko Library.
Make sure to set the "Include all branches" checkbox in the creation
dialog. After you've created a copy follow the Checklist section in
the README.
## Features
- Build & Test development workflow
- CI Setup
- Automatic Documentation generation for GitHub Pages
## How to develop
- Write your library code in `*.mo` source files in the `src/` directory.
- Run `make check` to make sure your changes compile (or use the
VSCode extension to get quicker feedback)
- Add tests to the source files in the `test/` directory, and run them
with `make test`. The project template is set up to include
motoko-matchers.
- Generate API documentation locally by running `make docs` and then
open the resulting `docs/index.html` in your browser
## How to publish
- Create a git tag for the commit you'd like to be the published
version. For example:
```bash
git tag v1.1.0
git push origin v1.1.0
```
- Follow the instructions at
[`vessel-package-set`](https://github.com/dfinity/vessel-package-set)
to make it easy for other to install your library
## Checklist
### Check the initial setup works
- [x] Make sure you've installed [`vessel`](https://github.com/dfinity/vessel)
- [x] Make sure you've installed [`wasmtime`](https://wasmtime.dev/)
- [x] Make sure `make all` runs succesfully. If it doesn't please [open an issue](https://github.com/kritzcreek/motoko-library-template)
### Licensing
- [x] This template comes with a copy of the Apache License Version
2.0, if you'd like to use a different license, replace the
LICENSE file.
- [x] Change the License section in the README to reference your
libraries name
### Host library documentation on Github Pages
If you'd like to automatically build and host library documentation
whenever you push a git tag, follow these steps. Otherwise delete
`.github/workflows/release.yml`, the `gh-pages` branch, and the API Documentation section in the README.
- [x] Turn on [Github Pages](https://pages.github.com/) in the Settings for your repo under:
`Settings -> GitHub Pages -> Source -> Pick the "gh-pages" branch`
- [x] Change the Url in the `API Documentation` section in your project
### Finishing touches
- [x] Check out the "How to develop" and "How to publish" sections in the
README and finally delete the Checklist section from the
README
## API Documentation
API documentation for this library can be found at https://flyq.github.io/motoko-sha224/
## Reference
1. https://github.com/enzoh/motoko-sha
2. https://golang.org/src/crypto/sha256/sha256.go
## License
motoko-library-template is distributed under the terms of the Apache License (Version 2.0).
See LICENSE for details.