From 2504693b3ee2271bb235e2bf59744b3569fe6325 Mon Sep 17 00:00:00 2001 From: Ryan Williams Date: Sun, 10 Dec 2017 03:56:31 +0000 Subject: [PATCH] update readmes --- README.md | 10 +++++----- src/main/scala/org/hammerlab/genomics/loci/README.md | 8 -------- 2 files changed, 5 insertions(+), 13 deletions(-) delete mode 100644 src/main/scala/org/hammerlab/genomics/loci/README.md diff --git a/README.md b/README.md index f3519e7..3b77ff8 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ [![Coverage Status](https://coveralls.io/repos/github/hammerlab/genomic-loci/badge.svg?branch=master)](https://coveralls.io/github/hammerlab/genomic-loci?branch=master) [![Maven Central](https://img.shields.io/maven-central/v/org.hammerlab.genomics/loci_2.11.svg?maxAge=1800)](http://search.maven.org/#search%7Cga%7C1%7Cgenomics%20loci) -Utilities for representing genomic loci and reference-genomes. +Utilities for working with genomic loci. -Contains three packages: -- [`loci`](src/main/scala/org/hammerlab/loci) -- [`reference`](src/main/scala/org/hammerlab/reference) -- [`strings`](src/main/scala/org/hammerlab/strings) +- [`parsing`](src/main/scala/org/hammerlab/genomics/loci/parsing): utilities for parsing string-representations of loci. +- [`set`](src/main/scala/org/hammerlab/genomics/loci/set): `LociSet` data-structure: stores genomic-loci ranges and allows for intersection/containment checks. +- [`map`](src/main/scala/org/hammerlab/genomics/loci/map): `LociMap` data-structure: allows for mapping genomic ranges to arbitrary values. +- [`iterator`](src/main/scala/org/hammerlab/genomics/loci/iterator): iterators for traversing genomic loci. diff --git a/src/main/scala/org/hammerlab/genomics/loci/README.md b/src/main/scala/org/hammerlab/genomics/loci/README.md deleted file mode 100644 index 1344f4f..0000000 --- a/src/main/scala/org/hammerlab/genomics/loci/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# `org.hammerlab.genomics.loci` - -Utilities for working with genomic loci. - -- [`parsing`](parsing): utilities for parsing string-representations of loci. -- [`set`](set): `LociSet` data-structure: stores genomic-loci ranges and allows for intersection/containment checks. -- [`map`](map): `LociMap` data-structure: allows for mapping genomic ranges to arbitrary values. -- [`iterator`](iterator): iterators for traversing genomic loci.