diff --git a/README.md b/README.md new file mode 100644 index 0000000..75f7fa2 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# utility-js + +JavaScript utility functions. + +## Install + +``` +npm install utility-js +``` + +## API + + +### forEach + +``` +function forEach( + array: (Array | ArrayLikeObject), + callback: Function + ): Array; + +callback = function ( + value: Object, + index: Number, + array: (Array | ArrayLikeObject) + ): (boolean | undefined); +``` \ No newline at end of file diff --git a/package.json b/package.json index b2d89bf..c20925f 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,19 @@ { - "name": "utility-js", - "version": "0.1.0", - "description": "Utility functions.", - "main": "utility.js", - "author": "Audi Nugraha ", - "license": "MIT" + "name": "utility-js", + "version": "0.1.0", + "description": "JavaScript utility functions.", + "main": "utility.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/audinue/utility-js.git" + }, + "author": "Audi Nugraha ", + "license": "MIT", + "bugs": { + "url": "https://github.com/audinue/utility-js/issues" + }, + "homepage": "https://github.com/audinue/utility-js#readme" }