Browse Source

readme fixes

Katya Demidova 9 years ago
parent
commit
29866c7bcd
1 changed files with 5 additions and 1 deletions
  1. 5 1
      readme.md

+ 5 - 1
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`