From 2bbb8ab8a24fbaa9eb82f8d7b70e3d9883be6597 Mon Sep 17 00:00:00 2001
From: Vinnie Falco <vinnie.falco@gmail.com>
Date: Thu, 15 Jun 2017 01:10:50 -0700
Subject: [PATCH] Documentation tidy

---
 README.md                    | 32 +++++++++++---------------------
 doc/concept/FieldsReader.qbk |  4 ++--
 2 files changed, 13 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index fd8a7867..46c05de2 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,6 @@
 ## Contents
 
 - [Introduction](#introduction)
-- [Audience](audience)
 - [Appearances](#appearances)
 - [Description](#description)
 - [Requirements](#requirements)
@@ -25,18 +24,14 @@
 
 ## Introduction
 
-Beast is a cross-platform, header-only C++11 library for low-level
-HTTP/1 and WebSocket protocol programming
-using the consistent asynchronous networking model of Boost.Asio.
-Beast is not an HTTP client or HTTP server, but it can be used to
-build those things. It is intended to be a foundation for writing
-other interoperable libraries by providing HTTP vocabulary types
-and algorithms. The provided examples show how clients and servers
-might be built.
+Beast is a C++ header-only library serving as a foundation for writing
+interoperable networking libraries by providing **low-level HTTP/1,
+WebSocket, and networking protocol** vocabulary types and algorithms
+using the consistent asynchronous model of Boost.Asio.
 
 This library is designed for:
 
-* **Symmetry:** Interfaces are role-agnostic; build clients, servers, or both.
+* **Symmetry:** Algorithms are role-agnostic; build clients, servers, or both.
 
 * **Ease of Use:** Boost.Asio users will immediately understand Beast.
 
@@ -45,16 +40,7 @@ This library is designed for:
 
 * **Performance:** Build applications handling thousands of connections or more.
 
-* **Basis for Further Abstraction.** Components are open-ended and
-  suited for building higher level libraries.
-
-## Audience
-
-Beast is for network programmers who have some familiarity with
-Boost.Asio. In particular, users who wish to write asynchronous programs
-with Beast should already know how to use Asio sockets and streams,
-and should know how to create concurrent network programs using
-Asio callbacks or coroutines.
+* **Basis for Further Abstraction.** Components are well-suited for building upon.
 
 ## Appearances
 
@@ -76,6 +62,10 @@ The library has been submitted to the
 
 ## Requirements
 
+This library is for programmers familiar with Boost.Asio. Users
+who wish to use asynchronous interfaces should already know how to
+create concurrent network programs using callbacks or coroutines.
+
 * **C++11:** Robust support for most language features.
 * **Boost:** Boost.Asio and some other parts of Boost.
 * **OpenSSL:** Optional, for using TLS/Secure sockets.
@@ -146,7 +136,7 @@ The files in the repository are laid out thusly:
     include/        Add this to your compiler includes
         beast/
     extras/         Additional APIs, may change
-    examples/       Self contained example programs
+    example/        Self contained example programs
     test/           Unit tests and benchmarks
 ```
 
diff --git a/doc/concept/FieldsReader.qbk b/doc/concept/FieldsReader.qbk
index 769d2e6d..aae62cd3 100644
--- a/doc/concept/FieldsReader.qbk
+++ b/doc/concept/FieldsReader.qbk
@@ -42,7 +42,7 @@ In this table:
     [`X(f,v,m)`]
     []
     [
-        The implementatation uses this constructor to indicate
+        The implementation calls this constructor to indicate
         that the fields being serialized form part of an HTTP
         request. The lifetime of `f` is guaranteed
         to end no earlier than after the `X` is destroyed.
@@ -51,7 +51,7 @@ In this table:
     [`X(f,v,c)`]
     []
     [
-        The implementatation uses this constructor to indicate
+        The implementation calls this constructor to indicate
         that the fields being serialized form part of an HTTP
         response. The lifetime of `f` is guaranteed
         to end no earlier than after the `X` is destroyed.