From 29866c7bcd948c93ab77098ac5146eccf9bafa42 Mon Sep 17 00:00:00 2001 From: Katya Demidova Date: Wed, 8 Jun 2016 03:37:04 +0300 Subject: [PATCH] readme fixes --- readme.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index f05c3bfa..5f8246a9 100644 --- a/readme.md +++ b/readme.md @@ -18,6 +18,8 @@ $ npm install --save-dev javascript-obfuscator ## Usage +Here's an example of how to use it: + ```javascript var JavaScriptObfuscator = require('javascript-obfuscator'); @@ -48,6 +50,8 @@ var _0xabf1 = [ ## `obfuscate(sourceCode, options)` +This is the main function that runs the Obfuscator. + #### `sourceCode` Type: `string` Default: `null` @@ -69,7 +73,7 @@ Options for the JavaScript obfuscator: #### `compact` Type: `boolean` Default: `true` -Compact code output one one line. +Compact code output on one line. #### `debugProtection` Type: `boolean` Default: `false`