From 7ae38f1567ad6ac8a1b6bd2f5c2c9347df635f69 Mon Sep 17 00:00:00 2001 From: Jon Michael Aanes Date: Mon, 5 Jun 2017 22:08:33 +0200 Subject: [PATCH] Small change to `README.md` --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d4c7c73..bbd5528 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,10 @@ ## Introduction -`pretty` is an advanced pretty printer for [Lua](lua.org). It attempts to -understand your datastructures and return a pretty printed string -representation. It's primary purpose is to be a good human-readable debugging -tool, not a speedy serialization tool. +`pretty` is an advanced pretty printer for [Lua](lua.org) aiming primarily for +human readability. This is done by looking for patterns in the input data, and +creating an output string utilizing and highlighting those patterns. Thus it's +a primarily a debugging tool, not a speedy serialization tool. Humans are flexible in their understanding of data, as long as certain underlying structural patterns can be found. `pretty` attempts to find those @@ -76,6 +76,7 @@ I'm looking into implementing following features: - Look into using concat operation to improve appearance of overly long non-breaking strings. Maybe even attempt to break near whitespace. - Attempt to fit output within a predefined width limit. Default to 80(?) +- Find a better name than `pretty`. ## Other pretty printers