Refactor prose

Author: wooorm

readme.md

@@ -5,18 +5,17 @@
 [![Downloads][downloads-badge]][downloads]
 [![Size][size-badge]][size]
 
-Transform a “database” / simple (word, phrase) list from plain-text to
-JSON.
+Transform a “database” / basic (word, phrase) list from plain text to JSON.
 
-## Installation
+## Install
 
 [npm][]:
 
-```bash
+```sh
 npm install plain-text-data-to-json
 ```
 
-## Usage
+## Use
 
 ```js
 var fs = require('fs')
@@ -33,8 +32,9 @@ fs.writeFileSync('output.json', JSON.stringify(data, null, 2) + '\n')
 
 ### `toJSON(value[, options])`
 
-Transforms the given value (string) to JSON.  Don’t like the default
-comment and property-value pair delimiters?  Specify your own:
+Transforms the given value (string) to JSON.
+Don’t like the default comment and property-value pair delimiters?
+Specify your own:
 
 ##### `options`
 
@@ -45,34 +45,35 @@ Character to use for line-comments, `false` turns off comments (`string` or
 
 ###### `options.delimiter`
 
-Character to use as delimiter between property-value pairs (`string`,
-default: `':'`)
+Character to use as delimiter between property-value pairs (`string`, default:
+`':'`)
 
 ###### `options.forgiving`
 
-How relaxed to be (`string` or `boolean`, default: `false`).  When `true`,
-doesn’t throw for duplicate keys.  When `"fix"`, doesn’t throw for
-property-value pairs and overwrites (see [errors][]).
+How relaxed to be (`'fix'` or `boolean`, default: `false`).
+When `true`, doesn’t throw for duplicate keys.
+When `'fix'`, doesn’t throw for property-value pairs and overwrites (see
+[errors][]).
 
 ###### `options.log`
 
 Whether to log when `forgiving` ignores an error (`boolean`, default: `true`).
 
 ## Why
 
-I found myself rewriting a simple transformation over and over.  This
-(verbosely named) project fixes that.  It might not be useful, or too
-simple for others, but suites my use cases.
+I found myself rewriting a simple transformation over and over.
+This (verbosely named) project fixes that.
+It might not be useful, or too simple for others, but suites my use cases.
 
-## “Plain-text”
+## “Plain text”
 
-The term plain-text might be confusing.  It’s actually more of some
-(sparingly specified) standard.
+The term plain text might be confusing.
+It’s actually more of some (sparingly specified) standard.
 
 ### Comments
 
-Use a percentage sign (by default) to specify a comment.  The comment
-will last until the end of line.
+Use a percentage sign (by default) to specify a comment.
+The comment will last until the end of line.
 
 ```txt
 % This is a completely commented line.
@@ -81,11 +82,11 @@ unicorn % This is a partially commented line.
 
 Yields:
 
-```json
-["unicorn"]
+```js
+['unicorn']
 ```
 
-### White Space
+### Whitespace
 
 Initial or final white space (`\s`) is trimmed from values.
 
@@ -95,14 +96,14 @@ Initial or final white space (`\s`) is trimmed from values.
 
 Yields:
 
-```json
-["unicorn"]
+```js
+['unicorn']
 ```
 
 ### Empty lines
 
-Empty lines will be striped.  This includes blank (white space only)
-lines.
+Empty lines are striped.
+This includes blank (whitespace only) lines.
 
 ```txt
     %%% this file contains a value. %%%
@@ -112,8 +113,8 @@ unicorn
 
 Yields:
 
-```json
-["unicorn"]
+```js
+['unicorn']
 ```
 
 ### Property-value pairs
@@ -126,8 +127,8 @@ unicorn : magic creature
 
 Yields:
 
-```json
-{"unicorn":"magic creature"}
+```js
+{unicorn: 'magic creature'}
 ```
 
 ### Values
@@ -151,8 +152,8 @@ Some errors are thrown when malformed “plain-text” is found, such as:
 *   When lines both with and without colons exist
 *   In arrays, when duplicate values exist (unless `forgiving: true`)
 *   In objects, when duplicate properties exist (unless `forgiving: true`)
-*   In objects, when duplicate properties with different values exist
-    (unless `forgiving: "fix"`)
+*   In objects, when duplicate properties with different values exist (unless
+    `forgiving: "fix"`)
 
 ## License