From 6a5bf2cddbc33a65c8d3c1b52e45885f72f086b8 Mon Sep 17 00:00:00 2001 From: "Alex A. Naanou" Date: Thu, 2 Jul 2020 18:29:25 +0300 Subject: [PATCH] docs... Signed-off-by: Alex A. Naanou --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 14bef68..9d5b837 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ # object-run.js +`object-run.js` implements the tools needed to use the [Concatinative +Programming Style](https://en.wikipedia.org/wiki/Concatenative_programming_language) +on native JavaScript structures/objects. + This module defines a singe method `.run(..)` on `Object.prototype` making -it visible from all JavaScript objects inheriting from Object. +it visible from all JavaScript objects inheriting from `Object`. -The `.run(..)` method simply executes a function in the context of object -from which `.run(..)` was called. - -The return value of `.run(..)` is the non-`undefined` return value of the -passed function. - -The use of `.run(..)` enables the concatinative programming style on any -JavaScript structure/object. +The `.run(..)` method simply executes a function in the context of the +object from which `.run(..)` was called. The return value of `.run(..)` +is the non-`undefined` return value of the passed function or the context +object otherwise. ## Installation @@ -65,6 +65,9 @@ var l = [1, 2, 3, 4, 5] -> ``` +If `()` returns `undefined` then `.run(..)` will return ``. + + ## License