rs-ucan

This is a Rust library to help the next generation of web applications make use of UCANs in their authorization flows. To learn more about UCANs and how you might use them in your application, visit https://ucan.xyz or read the spec.

Outline

• Crates
• Building the Project
• Testing the Project
• Contributing
• Getting Help
• License

Crates

• ucan
• ucan-key-support

Building the Project

• Clone the repository.

  git clone https://github.com/ucan-wg/rs-ucan.git

• Change directory

  cd rs-ucan

• Build the project

  cargo build

Testing the Project

• Run tests

  cargo test

Contributing

Pre-commit Hook

This library recommends using pre-commit for running pre-commit hooks. Please run this before every commit and/or push.

• Once installed, Run pre-commit install to setup the pre-commit hooks locally. This will reduce failed CI builds.
• If you are doing interim commits locally, and for some reason if you don't want pre-commit hooks to fire, you can run git commit -a -m "Your message here" --no-verify.

Conventional Commits

This library lightly follows the Conventional Commits convention to help explain commit history and tie in with our release process. The full specification can be found here. We recommend prefixing your commits with a type of fix, feat, docs, ci, refactor, etc..., structured like so:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Getting Help

For usage questions, usecases, or issues reach out to us in our rs-ucan Discord channel.

We would be happy to try to answer your question or try opening a new issue on Github.

License

This project is licensed under the Apache License 2.0.