From ee085d32848d591006fde9d8bb3e4ebaf9638a6c Mon Sep 17 00:00:00 2001 From: ehmicky Date: Sun, 18 Aug 2024 17:55:50 +0100 Subject: [PATCH] Remove examples --- CHANGELOG.md | 6 ++++++ README.md | 7 ------- examples/README.md | 5 ----- examples/main.js | 36 ------------------------------------ 4 files changed, 6 insertions(+), 48 deletions(-) delete mode 100644 examples/README.md delete mode 100644 examples/main.js diff --git a/CHANGELOG.md b/CHANGELOG.md index f5357f9..0da5f39 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +# 6.1.0 + +## Features + +- Decrease package size by removing examples. + # 6.0.0 ## Breaking changes diff --git a/README.md b/README.md index aedc655..6b1dcc1 100644 --- a/README.md +++ b/README.md @@ -47,13 +47,6 @@ for (const values of bigCartesian([ // [ 'blue', 'square' ] ``` -# Demo - -You can try this library: - -- either directly [in your browser](https://repl.it/@ehmicky/big-cartesian). -- or by executing the [`examples` files](examples/README.md) in a terminal. - # Install ``` diff --git a/examples/README.md b/examples/README.md deleted file mode 100644 index 448c7a7..0000000 --- a/examples/README.md +++ /dev/null @@ -1,5 +0,0 @@ -This directory contains [examples](main.js) of this library. They can be run and -edited: - -- either directly [in your browser](https://repl.it/@ehmicky/big-cartesian) -- or in a terminal by cloning this repository diff --git a/examples/main.js b/examples/main.js deleted file mode 100644 index 9d73cf4..0000000 --- a/examples/main.js +++ /dev/null @@ -1,36 +0,0 @@ -// Demo of big-cartesian. -// This file can be directly run: -// - first install `big-cartesian` -// - then `node node_modules/big-cartesian/examples/main.js` -// An online demo is also available at: -// https://repl.it/@ehmicky/big-cartesian - -import bigCartesian from 'big-cartesian' - -// Iterate over combinations -// eslint-disable-next-line fp/no-loops -for (const values of bigCartesian([ - ['red', 'blue'], - ['circle', 'square'], -])) { - console.log(values) -} -// [ 'red', 'circle' ] -// [ 'red', 'square' ] -// [ 'blue', 'circle' ] -// [ 'blue', 'square' ] - -const generator = function* () { - yield 'circle' - yield 'square' -} - -// Notice we pass the function itself: `generator` not `generator()` -// eslint-disable-next-line fp/no-loops -for (const values of bigCartesian([['red', 'blue'], generator])) { - console.log(values) -} -// [ 'red', 'circle' ] -// [ 'red', 'square' ] -// [ 'blue', 'circle' ] -// [ 'blue', 'square' ]