Documentation improvements.

csw · Aug 2, 2012 · 9521548 · 9521548
1 parent 0ba5ea3
commit 9521548
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -2,8 +2,8 @@
 
 [![Build Status](https://secure.travis-ci.org/csw/bioruby-bgzf.png)](http://travis-ci.org/csw/bioruby-bgzf)
 
-This library provides support for the [BGZF][] (Blocked GZip Format)
-in Ruby. BGZF, originally defined as part of the [SAM/BAM][]
+This library provides support for [BGZF][] (Blocked GZip Format) in
+Ruby. BGZF, originally defined as part of the [SAM/BAM][]
 specification, is used to compress record-oriented bioinformatics data
 in a way that facilitates random access, unlike plain gzip. A BGZF
 file consists of contatenated 64 KB blocks, each an independent gzip

diff --git a/Rakefile b/Rakefile
@@ -18,7 +18,7 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/csw/bioruby-bgzf"
   gem.license = "MIT"
   gem.summary = %Q{Reading/writing BGZF blocks}
-  gem.description = %Q{BGZF compression is used nowadays only for providing random access to BAM format. However, it is completely independent from the format, and can be used for arbitrary data format. The gem allows to read BGZF blocks from streams and pack strings into blocks, aiming to facilitate introducing BGZF compression for Ruby users.}
+  gem.description = %Q{This library provides support for BGZF (Blocked GZip Format) in Ruby. BGZF, originally defined as part of the SAM/BAM specification, is used to compress record-oriented data in a way that facilitates random access, unlike plain gzip. BGZF is principally used for bioinformatics data but would be useful in other contexts as well.}
   gem.email = "cswh@umich.edu"
   gem.authors = ["Artem Tarasov", "Clayton Wheeler"]
   # dependencies defined in Gemfile