Skip to content

Commit fb31666

Browse files
committed
added simple docs instruction
1 parent b3849bd commit fb31666

File tree

1 file changed

+42
-3
lines changed

1 file changed

+42
-3
lines changed

README.md

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,43 @@
1-
# github-action-javascript-obfuscator
2-
Github action to obfuscate javascript code by using the javascript-obfuscator (obfuscator.io)
1+
# :package: Github Action `Javascript obfuscator`
32

4-
> **_NOTE:_** In Progress
3+
> A Github action to obfuscate javascript code by using the [javascript-obfuscator](https://github.com/javascript-obfuscator/javascript-obfuscator)
4+
5+
> **_NOTE:_** This Github action is still in work. It`s not ready to use yet.
6+
7+
## About
8+
9+
Obfuscate javascript and node with Github action to secure your code.
10+
The Github action uses the [javascript-obfuscator](https://github.com/javascript-obfuscator/javascript-obfuscator).
11+
12+
## Usage
13+
14+
>:white_flag: See the [inputs](#inputs) section for detailed descriptions.
15+
16+
### Example low obfuscation
17+
18+
```yml
19+
- name: Create distribution path
20+
run: |
21+
mkdir -p distribution_path
22+
23+
- name: Low obufscation test
24+
uses: ./
25+
with:
26+
input_path: input_path
27+
output_path: distribution_path
28+
compact: true
29+
control_flow_flattening: false
30+
dead_code_injection: false
31+
debug_protection: false
32+
debug_protection_interval: 0
33+
log: false
34+
disable_console_output: true
35+
rename_globals: false
36+
string_array_rotate: true
37+
self_defending: true
38+
string_array: true
39+
string_array_encoding: 'none'
40+
string_array_threshold: 0.75
41+
unicode_escape_sequence: false
42+
target: node
43+
```

0 commit comments

Comments
 (0)