Add more package details

This commit is contained in:
Jake Howard 2016-03-25 15:39:04 +00:00
parent 75b6c222af
commit e1374f8f21
2 changed files with 30 additions and 2 deletions

View file

@ -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 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 <input> -o <output> -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/).

View file

@ -1,7 +1,7 @@
{ {
"name": "jsfuckify", "name": "jsfuckify",
"version": "0.0.0", "version": "0.0.0",
"description": "", "description": "Browserify transformer and CLI to convert normal JS into JSFuck",
"main": "lib/index.js", "main": "lib/index.js",
"scripts": { "scripts": {
"postinstall": "npm run create-dirs", "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'", "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'" "mocha": "mocha --require scripts/test-helper.js --bail 'tests/**/*.js'"
}, },
"keywords": [
"jsfuck",
"jscrewit",
"esoteric"
],
"bin": "./bin/cli.js", "bin": "./bin/cli.js",
"author": "TheOrangeOne <git@theorangeone.net>", "author": "TheOrangeOne <git@theorangeone.net>",
"dependencies": { "dependencies": {