Skip to content

Commit

Permalink
Add links to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nvictus committed Feb 2, 2024
1 parent 6d16b4e commit f5a14d8
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Bigtools <a href="https://github.com/jackh726/bigtools"><img align="right" src="https://github.com/jackh726/bigtools/raw/master/assets/bigtools-logo.svg" height="38"></img></a>

[![crates.io](https://img.shields.io/crates/v/bigtools.svg)](https://crates.io/crates/bigtools)
[![Documentation](https://docs.rs/bigtools/badge.svg)](https://docs.rs/bigtools)
[![Rust Docs](https://docs.rs/bigtools/badge.svg)](https://docs.rs/bigtools)
[![Zenodo](https://zenodo.org/badge/DOI/10.5281/zenodo.10606493.svg)](https://doi.org/10.5281/zenodo.10606493)

Bigtools is a library and associated tools for reading and writing bigwig and bigbed files.
Expand All @@ -25,6 +25,8 @@ Bigtools is written in Rust and published to `crates.io`, so binaries can be ins

## Library

See the `bigtools` 🦀 [Documentation](https://docs.rs/bigtools).

### Example

```rust,norun
Expand All @@ -41,6 +43,10 @@ for interval in chr1 {

TODO

## Python wrapper

See the `pybigtools` 🐍 [API Documentation](https://bigtools.readthedocs.io/en/latest).

## Benchmarks
[Benchmarks]: #Benchmarks

Expand Down

0 comments on commit f5a14d8

Please sign in to comment.