From 5f9476968ad99279dce0bfa228d1133cecf52ea9 Mon Sep 17 00:00:00 2001 From: Arve Seljebu Date: Sun, 20 Aug 2017 18:48:49 +0200 Subject: [PATCH] add max to function signature --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 463ec1f..0dd7c0f 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,12 @@ Combinations [![Build Status](https://travis-ci.org/jgallen23/combinations.svg?b # Usage - combinations(array[, min_output_array_size]) + combinations(array[, min, max]) * takes in an array, and outputs an array of arrays, containing all possible combinations of values in the original array. * combinations are of all sizes: all combinations of one element, and all combinations of 2 elements, and so on -* minimum number of elements in a combination can be specified (min_output_array_size) -* maximum number of elements in a combination can be also specified +*   `min` sets minimum number of elements in a combination +*   `max` sets maximum number of elements in a combination * if maximum combination value is bigger than array elements it will be overridden to the array length # Example @@ -53,4 +53,4 @@ Combinations [![Build Status](https://travis-ci.org/jgallen23/combinations.svg?b // [ 'red', 'green' ], [ 'orange', 'yellow' ], // [ 'orange', 'green' ], [ 'yellow', 'green' ], // [ 'red', 'orange', 'yellow' ], [ 'red', 'orange', 'green' ], - // [ 'red', 'yellow', 'green' ], [ 'orange', 'yellow', 'green' ] ] \ No newline at end of file + // [ 'red', 'yellow', 'green' ], [ 'orange', 'yellow', 'green' ] ]