diff --git a/CHANGELOG.md b/CHANGELOG.md index 9d94c79..8d30203 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [2.0.1] - 2022-feb-11 +### Fixed +- readme + ## [2.0.0] - 2022-feb-09 ### Changed - deleteByKey to delete item by its key diff --git a/README.md b/README.md index 4a2b17a..54972ef 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ An implementation of the round robin as a data structure. Two strategies are imp * [API](#api) * [import](#import) * [constructor](#constructor) - * [add(item)](#additem) + * [add(value)](#addvalue) * [count()](#count) * [next()](#next) * [deleteByKey(key)](#deletebykeykey) @@ -52,7 +52,7 @@ import { ``` ### constructor -constructor accepts an initial list of items that will be loaded internally and given unique keys. +accepts an initial list of values. #### JS @@ -61,7 +61,7 @@ constructor accepts an initial list of items that will be loaded internally and params - items: array + values: array @@ -78,7 +78,7 @@ const randomTable = new RandomRoundRobin([5, 10, 15]); params - items: T[] + values: T[] @@ -88,7 +88,7 @@ const sequentialTable = new SequentialRoundRobin(['T1', 'T2', 'T3']); const randomTable = new RandomRoundRobin([5, 10, 15]); ``` -### add(item) +### add(value) adds a new item to the table. #### JS @@ -99,7 +99,7 @@ adds a new item to the table. return - item: any + value: any object @@ -120,7 +120,7 @@ console.log(key, value); // 3, 25 return - item: T + value: T RoundRobinItem<T> diff --git a/package.json b/package.json index 10dea4b..330ed3a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "round-robin-js", - "version": "2.0.0", + "version": "2.0.1", "description": "an implementation of round robin as a data structure", "main": "index.js", "scripts": {