Skip to content

Commit

Permalink
chore: updates the README to include information about the Rust packages
Browse files Browse the repository at this point in the history
  • Loading branch information
claymcleod committed Oct 15, 2023
1 parent f00d244 commit 1e611f7
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@
</p>
</p>

## Developing

The specification is generated using the [Rust] packages contained with `packages` directory. In particular, [`utoipa`] is used to autogenerate the OpenAPI 3.0 specification. An [Actix Web] server is provided that (a) provides the foundation for `utoipa` to generate the API documentation and (b) provides an example server using fake data. Please refer to the [Learn Rust] guide to learn how to develop using Rust.

## Contributing

### Development Process
Expand All @@ -27,4 +31,9 @@

- This repository uses the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) style for commit messages. Please make sure all commits conform to this style.
- This repository, as well as the API itself, are versioned using the latest version of [Semantic Versioning](https://semver.org/).
- All changes will either be squashed and merged or rebased off of the `main` branch—no merge commits are allowed in this repository.
- All changes will either be squashed and merged or rebased off of the `main` branch—no merge commits are allowed in this repository.

[Actix Web]: https://actix.rs/
[Learn Rust]: https://www.rust-lang.org/learn
[Rust]: https://www.rust-lang.org/
[`utoipa`]: https://github.com/juhaku/utoipa

0 comments on commit 1e611f7

Please sign in to comment.