Skip to content

Commit

Permalink
[DOC] Add online documentation link and citing.
Browse files Browse the repository at this point in the history
  • Loading branch information
smehringer committed Oct 31, 2023
1 parent dab5972 commit 4316155
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,17 @@ int main()
}
```

### A more detailed example
## Where to look for more information

* The [online API documentation](https://hibf.vercel.app/topics.html) for details on the data structures

## Please cite

If you are working with the HIBF, please cite:

> Hierarchical Interleaved Bloom Filter: enabling ultrafast, approximate sequence queries; Svenja Mehringer, Enrico Seiler, Felix Droop, Mitra Darvish, René Rahn, Martin Vingron, and Knut Reinert; Genome Biol 24, 131 (2023). doi: https://doi.org/10.1186/s13059-023-02971-4
## A more detailed example

<!-- MARKDOWN-AUTO-DOCS:START (CODE:src=./test/snippet/readme.cpp) -->
<!-- The below code snippet is automatically added from ./test/snippet/readme.cpp -->
Expand Down

0 comments on commit 4316155

Please sign in to comment.