chore: added readme, license, codecov

Author: hbarcelos

.gitignore

@@ -1 +1,3 @@
+.nyc_output
+coverage/
 node_modules/

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2020 Henrique Barcelos \<[email protected]\>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,162 @@
+# Round Linked Queue
+
+[![Coverage Status](https://coveralls.io/repos/github/hbarcelos/round-linked-queue/badge.svg?branch=master)](https://coveralls.io/github/hbarcelos/round-linked-queue?branch=master)
+
+Implements a fixed-size linked-list based queue. When trying to add an element to a full queue, it will evict the first added item in order to make room for the new element. This queue preserves the First In/First Out operation mode.
+
+## How it works?
+
+Given a queue of capacity 3, initially empty:
+
+```
+(Nil)
+```
+
+Calling `queue.add(1)` will put `1` at the beginning of the queue:
+
+```
+(1) -> (Nil)
+```
+
+Then `queue.add(2)` will turn it into:
+
+```
+(1) -> (2) -> (Nil)
+```
+
+Once more, with `queue.add(3)` we will have:
+
+```
+(1) -> (2) -> (3) -> (Nil)
+```
+
+Now the queue is at capacity. If we try to add another element, it will remove the element that was added first and shift all elements to the right. Consider `queue.add(4)`, the final result will be:
+
+```
+(2) -> (3) -> (4) -> (Nil)
+
+(1) // <--- removed element will be returned
+```
+
+## Installation
+
+```sh
+yarn add round-linked-queue
+# or with NPM
+# npm install --save round-linked-queue
+```
+
+## API
+
+### constructor
+
+```
+new RoundLinkedQueue(maxLength: number) => RoudLinkedQueue
+```
+
+Params:
+- `maxLength: number`: the capacity of the queue.
+
+### #add()
+
+```
+add(element: Any) => Any
+```
+
+Params:
+- `element: Any`: the element to add to the queue.
+
+Returns:
+- `undefined`: if the queue is not at capacity, because no element was removed.
+- `Any`: the removed element if the queue is at capacity.
+
+### #remove()
+
+```
+remove() => Any, throws Error
+```
+
+Returns:
+- `Any`: the removed element if the queue is not empty.
+
+Throws:
+- `Error`: if the queue is empty.
+
+
+### #toArray()
+
+```
+toArray() => [Any]
+```
+
+Returns:
+- `[Any]`: an Array with all elements in the queue.
+
+### #*\[Symbol.iterator\]()
+
+```
+*[Symbol.iterator]() => [Any]
+```
+
+Returns:
+- `Iterator`: an iterator for the queue.
+
+
+### .maxLength
+
+```
+get maxLength => Number
+```
+
+Returns:
+- `Number`: the capacity of the queue.
+
+### .first
+
+```
+get first => Any, throws Error
+```
+
+Returns:
+- `Any`: the first element in the queue if it is not empty.
+
+Throws:
+- `Error`: if the queue is empty.
+
+
+### .last
+
+```
+get last => Any, throws Error
+```
+
+Returns:
+- `Any`: the last element in the queue if it is not empty.
+
+Throws:
+- `Error`: if the queue is empty.
+
+
+### static fromArray
+
+```
+RoundLinkedQueue.fromArray(inputArray: [Any]) => RoudLinkedQueue
+```
+
+Params:
+- `inputArray: [Any]`: an arbitrary array of elements.
+
+Returns:
+-  `RoundLinkedQueue`: a new instance of the queue containing all elements in the array, respecting the insertion order.
+
+## Contributing
+
+### Running tests
+
+After clonnig this repo, run:
+
+```
+yarn test **.test.js
+# or with NPM
+# npm run test **.test.js
+```

package.json

@@ -4,16 +4,18 @@
   "description": "Fixed size round linked queue implementation in Javascript",
   "main": "round-linked-queue.js",
   "scripts": {
-    "test": "mocha"
+    "test": "nyc --reporter=html --reporter=text mocha",
+    "coverage": "nyc report --reporter=text-lcov | coveralls"
   },
   "keywords": [
     "queue",
     "data structures"
   ],
-  "author": "Henrique Barcelos <rick.hjpbarcelos@gmail.com>",
-  "license": "ISC",
+  "author": "Henrique Barcelos <hbarcelos909@gmail.com>",
+  "license": "MIT",
   "devDependencies": {
     "chai": "^4.2.0",
+    "coveralls": "^3.0.9",
     "eslint": "^6.8.0",
     "eslint-config-prettier": "^6.10.0",
     "eslint-config-prettier-standard": "^3.0.1",
@@ -24,6 +26,8 @@
     "eslint-plugin-promise": "^4.2.1",
     "eslint-plugin-standard": "^4.0.1",
     "mocha": "^7.0.1",
+    "mocha-lcov-reporter": "^1.3.0",
+    "nyc": "^15.0.0",
     "prettier": "^1.19.1",
     "prettier-config-standard": "^1.0.1"
   }