From 77cb59fe9e845f9e526f3e23ec074ed0bffef295 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20L=C3=BCck?= <christian@lueck.tv>
Date: Fri, 6 Sep 2019 10:02:02 +0200
Subject: [PATCH] Update project homepage

---
 README.md       | 17 ++++++++++-------
 composer.json   |  4 ++--
 src/Decoder.php |  6 ++++++
 3 files changed, 18 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 8dafd30..4dcb3d6 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,12 @@
-# clue/tar-react [![Build Status](https://travis-ci.org/clue/php-tar-react.svg?branch=master)](https://travis-ci.org/clue/php-tar-react)
+# clue/reactphp-tar [![Build Status](https://travis-ci.org/clue/reactphp-tar.svg?branch=master)](https://travis-ci.org/clue/reactphp-tar)
 
-Async, streaming parser for the [TAR file format](https://en.wikipedia.org/wiki/Tar_%28computing%29) (Tape ARchive),
-built on top of [React PHP](http://reactphp.org/).
+Streaming parser to extract tarballs with [ReactPHP](https://reactphp.org/).
 
-Implements UStar (Uniform Standard Tape ARchive) format, introduced by the POSIX IEEE P1003.1
+The [TAR file format](https://en.wikipedia.org/wiki/Tar_%28computing%29) is a
+common archive format to store several files in a single archive file (commonly
+referred to as "tarball" with a `.tar` extension). This lightweight library
+provides an efficient implementation to extract tarballs in a streaming fashion,
+processing one chunk at a time in memory without having to rely on disk I/O.
 
 **Table of Contents**
 
@@ -44,8 +47,8 @@ See also the [examples](examples).
 
 ## Install
 
-The recommended way to install this library is [through composer](https://getcomposer.org).
-[New to composer?](https://getcomposer.org/doc/00-intro.md)
+The recommended way to install this library is [through Composer](https://getcomposer.org).
+[New to Composer?](https://getcomposer.org/doc/00-intro.md)
 
 ```JSON
 {
@@ -84,5 +87,5 @@ MIT
   the underlying [react/stream](https://github.com/reactphp/stream) component.
 
 * If you want to process compressed tarballs (`.tar.gz` and `.tgz` file extension), you may
-  want to use [clue/zlib-react](https://github.com/clue/php-zlib-react) on the compressed
+  want to use [clue/reactphp-zlib](https://github.com/clue/reactphp-zlib) on the compressed
   input stream before passing the decompressed stream to the tar decoder.
diff --git a/composer.json b/composer.json
index 29108ed..af20c11 100644
--- a/composer.json
+++ b/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "clue/tar-react",
-    "description": "Async, streaming parser for the TAR file format (Tape ARchive), built on top of React PHP",
-    "keywords": ["tar", "archive", "parser", "decoder", "extractor", "unpacker", "ReactPHP", "async"],
+    "description": "Streaming parser to extract tarballs with ReactPHP.",
+    "keywords": ["tar", "archive", "tarball", "untar", "parser", "decoder", "extract", "unpack", "ReactPHP", "async"],
     "homepage": "https://github.com/clue/php-tar-react",
     "license": "MIT",
     "authors": [
diff --git a/src/Decoder.php b/src/Decoder.php
index f3d7e00..e61028b 100644
--- a/src/Decoder.php
+++ b/src/Decoder.php
@@ -8,6 +8,12 @@
 use Exception;
 
 /**
+ * Decodes a TAR stream and emits "entry" events for each individual file in the archive.
+ *
+ * At the moment, this class implements the the `UStar` (Uniform Standard Tape ARchive) format,
+ * introduced by POSIX IEEE P1003.1. In the future, it should support more of
+ * the less common alternative formats.
+ *
  * @event entry(array $header, ReadableStream $stream, Decoder $thisDecoder)
  * @event error(Exception $e, Decoder $thisDecoder)
  * @event close()