diff --git a/README.md b/README.md index 783e9c5..630757c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,35 @@ -# Core Algorithms +# Core Algorithms [Classic, Numeric, Set] -Tests and implementations for algorithms commonly used in job interviews. See the full list in the [algorithms.md](algorithms.md) file. +- [x] Artifact produced is a fork of the [core-algorithms][core-algorithms] repo. +- [x] Can run all tests with npm test. +- [x] ```makeChange()``` algorithm is implemented according to the description in algorithms.md. +- [x] Tests for ```makeChange()``` exist with at least 2 unit tests using valid inputs, and at least 1 unit test using invalid inputs. +- [x] ```fizzBuzz()``` algorithm is implemented according to the description in algorithms.md. +- [x] Tests for ```fizzBuzz()``` exist. +- [x] ```isPalindrome()``` algorithm is implemented according to the description in algorithms.md. +- [x] Tests for ```isPalindrome()``` exist with at least 2 unit tests using valid inputs. +- [x] ```factorial()``` algorithm is implemented according to the description in algorithms.md. +- [x] Tests for ```factorial()``` exist with at least 2 unit tests using valid inputs. +- [x] ```fibonacci()``` algorithm is implemented according to the description in algorithms.md. +- [x] Tests for ```fibonacci()``` exist with at least 2 unit tests using valid inputs, and at least 1 unit test using invalid inputs. +- [x] ```collatzConjecture()``` algorithm is implemented according to the description in algorithms.md. +- [x] Tests for ```collatzConjecture()``` exist with at least 2 unit tests using valid inputs, and at least 1 unit test using invalid inputs. +- [x] ```setUnion()``` algorithm is implemented according to the description in algorithms.md. +- [x] Tests for ```setUnion()``` exist with at least 2 unit tests using valid inputs, and at least 1 unit test using invalid inputs. +- [x] ```setIntersection()``` algorithm is implemented according to the description in algorithms.md. +- [x] Tests for ```setIntersection()``` exist with at least 2 unit tests using valid inputs, and at least 1 unit test using invalid inputs. +- [x] ```setComplement()``` algorithm is implemented according to the description in algorithms.md. +- [x] Tests for ```setComplement()``` exist with at least 2 unit tests using valid inputs, and at least 1 unit test using invalid inputs. +- [x] ```setSymmetricDifference()``` algorithm is implemented according to the description in algorithms.md. +- [x] Tests for ```setSymmetricDifference()``` exist with at least 2 unit tests using valid inputs, and at least 1 unit test using invalid inputs. +- [x] Repository includes a README file with basic installation and setup instructions. +- [x] All dependencies are properly declared in package.json. +- [x] All major features are added via pull requests with a clear description and concise commit messages. +- [x] Code uses a linter and there are no linting errors. +- [x] Variables, functions, files, etc. have appropriate and meaningful names. +- [x] Functions are small and serve a single purpose. +- [x] The artifact produced is properly licensed, preferably with the [MIT license][mit-license]. -Base repository for the [Core Algorithms](http://jsdev.learnersguild.org/goals/123) goal. ## Installation and Setup