diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6fd911c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +# :pencil2: Contributing +## Pre-requisites +- `node` +- `make` + +### Testing +> The makefile installs a local copy of `jasmine` to run tests. + +**Node Tests**: `make test` + +**Browser Tests**: Open `SpecRunner.html` in a web browser. + +### Building +> The makefile installs a local copy of `uglify-es` for beautification/minification. + +**Production Build**: `make prod` +Saves comment-less and minified versions of `src/differentia.js` into a `prod-build` directory. + +### Clean Build/Test +Add `clean` at the end to remove `node_modules` afterwards. \ No newline at end of file diff --git a/README.md b/README.md index 59e12ef..4390414 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,6 @@ Differentia.js === -An Object Algorithm Library for JavaScript. - - - ---- - -# :page_facing_up: Supported Data Types -DataType|Clone|Diff ----|---|--- -Function|:x:|:x: -Symbol|:x:|:x: -Blob|:x:|:x: -Object|:white_check_mark:|:white_check_mark: -Array|:white_check_mark:|:white_check_mark: -String|:white_check_mark:|:white_check_mark: -Number|:white_check_mark:|:white_check_mark: -Boolean|:white_check_mark:|:white_check_mark: -RegExp|:white_check_mark:|:white_check_mark: ---- - -# :closed_book: Documentation -Differentia.js provides a basic suite of Object/Array focused utilities. They are all "deep" algorithms, and fully traverse all child Objects/Arrays/properties unless given a search index object with specifies otherwise. +This library provides a basic suite of Object/Array focused functions. They are all "deep" algorithms, and fully traverse all child Objects/Arrays/properties unless given a search index object with specifies otherwise. - Deep Object Cloning - Deep Object Diffing @@ -29,6 +8,9 @@ Differentia.js provides a basic suite of Object/Array focused utilities. They ar - Differential Deep Object Cloning - A small compliment of higher-order functions. +--- + +# :closed_book: Documentation ## Functions - [Main Functions](#main-functions) - [iddfs](#iddfs) @@ -43,6 +25,19 @@ Differentia.js provides a basic suite of Object/Array focused utilities. They ar - [some](#some) - [every](#every) +# :page_facing_up: Supported Data Types +DataType|Clone|Diff +---|---|--- +Function|:x:|:x: +Symbol|:x:|:x: +Blob|:x:|:x: +Object|:white_check_mark:|:white_check_mark: +Array|:white_check_mark:|:white_check_mark: +String|:white_check_mark:|:white_check_mark: +Number|:white_check_mark:|:white_check_mark: +Boolean|:white_check_mark:|:white_check_mark: +RegExp|:white_check_mark:|:white_check_mark: + --- # Main Functions diff --git a/makefile b/makefile index f11fa0f..b2d9479 100644 --- a/makefile +++ b/makefile @@ -1,5 +1,5 @@ noargs : - @printf "+------------------------------+\n| Differentia.js Build Options |\n+------------------------------+\-> Run Tests: 'make test'\n-> Production: 'make prod'\n-> Clean Build: 'make prod clean'\n" + @printf "+------------------------------+\n| Differentia.js Build Options |\n+------------------------------+\n-> Run Tests: 'make test'\n-> Production Build: 'make prod'\n-> Clean Build: 'make prod clean'\n" node_modules/uglify-es/bin/uglifyjs : @printf "Downloading uglifyjs from GitHub...\n" diff --git a/package.json b/package.json index 8664197..7b568e6 100644 --- a/package.json +++ b/package.json @@ -1,10 +1,31 @@ { - "name": "Differentia.js", + "name": "differentia", "version": "1.0.2", - "description": "An Object Algorithm library for JavaScript", + "description": "An Object Algorithm library for JavaScript", + "keywords": [ + "objects", + "diff", + "deep", + "library", + "higher-order-functions", + "iterator", + "graph-algorithms", + "clone", + "iddfs", + "traverse", + "search-algorithm", + "deepfreeze", + "deep-search", + "graph-theory", + "graph-search" + ], + "homepage": "https://github.com/Floofies/Differentia.js#readme", "repository": { "type": "git", "url": "https://github.com/Floofies/Differentia.js.git" + }, + "bugs": { + "url": "https://github.com/Floofies/Differentia.js/issues" }, "devDependencies": { "jasmine": "^2.8.0",