Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update readme #41

Merged
merged 1 commit into from
Oct 22, 2024
Merged

chore: update readme #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,17 @@ Language.

## Quickstart

You can add Integraal to your project by adding this to its manifest:
You can add `integraal` as a dependency of your project by adding the following lines to its Cargo.toml:

```toml
# in the Cargo.toml

[dependencies]
# other deps...
# [dependencies]
integraal = { version = "*" }
```
or by running:

```sh
cargo add integraal
```

The Rust Doc is available for usage instructions, examples are provided with the source code / in the repository.

Expand All @@ -47,4 +49,4 @@ The [SPDX](https://spdx.dev) license identifier for this project is `MIT OR Apac

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
dual licensed as above, without any additional terms or conditions.