Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
sstadick committed Mar 4, 2022
1 parent 8909a0f commit ae6dfc5
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,28 @@ For more details see [here](https://github.com/fulcrumgenomics/fgbio/wiki/Read-S
## Documentation and Examples

Please see the generated [Rust Docs](https://docs.rs/read_structure).

## How to use in your project

Add the following to your `Cargo.toml` dependencies section, updating the version number as needed.

```toml
[dependencies]
read-structure = "*"
```

## How to build and test locally

Assuming you have cloned the repo and are in the top level:

```bash
cargo test
```

## How to publish

This assumes that you have installed `cargo-release` via `cargo install cargo-release` and have set up credentials with `crates.io`.

```bash
cargo release <path|minor|major>
```

0 comments on commit ae6dfc5

Please sign in to comment.