diff --git a/README.md b/README.md index fb6295c..afa4c22 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,25 @@ -# JSFuckify +# JSFuckify [![Circle CI](https://circleci.com/gh/RealOrangeOne/JSFuckify.svg?style=svg)](https://circleci.com/gh/RealOrangeOne/JSFuckify) + Browserify transformer and CLI to convert normal JS into JSFuck + +## Installation +Installation can be done using [npm](https://www.npmjs.com/package/jsfuckify). + + npm install jsfuckify --save + + +## Usage +#### With Browserify + + browserify -o -t jsfuckify + +#### CLI +CLI Support coming soon! + +## How it works +This transform uses the [jscrewit](https://github.com/fasttime/JScrewIt) module to do the conversion, and adds minimal overhead to keep the build time fast! + +## What is JSFuck? +JSFuck is an esoteric and educational programming style based on the atomic parts of JavaScript. It uses only six different characters to write and execute code. It does not depend on a browser, so you can even run it on Node.js. + +More info can be found [here](http://www.jsfuck.com/). diff --git a/package.json b/package.json index 530d7cb..5c7ece0 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "jsfuckify", "version": "0.0.0", - "description": "", + "description": "Browserify transformer and CLI to convert normal JS into JSFuck", "main": "lib/index.js", "scripts": { "postinstall": "npm run create-dirs", @@ -13,6 +13,11 @@ "coverage": "istanbul cover node_modules/.bin/_mocha -- --require scripts/test-helper.js --bail --recursive 'tests/*.js'", "mocha": "mocha --require scripts/test-helper.js --bail 'tests/**/*.js'" }, + "keywords": [ + "jsfuck", + "jscrewit", + "esoteric" + ], "bin": "./bin/cli.js", "author": "TheOrangeOne ", "dependencies": {