Skip to content

Commit 45894ec

Browse files
committed
New Readme.md
1 parent 7a41b4a commit 45894ec

File tree

1 file changed

+32
-4
lines changed

1 file changed

+32
-4
lines changed

readme.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,36 @@
11
# :fire: Prometheus
2-
Prometheus is a Lua obfuscator written in pure Lua.
3-
[Documentation](https://levno-710.gitbook.io/prometheus/)
2+
## Description
3+
Prometheus is a Lua obfuscator written in pure Lua.
44

5+
This Project was inspired by the amazing [javascript-obfuscator](https://github.com/javascript-obfuscator/javascript-obfuscator).
6+
It can currently obfuscate Lua51 and Roblox's LuaU, however LuaU support is not finished yet.
57

6-
**NOTE**
8+
You can find the full Documentation including a getting started guide [here](https://levno-710.gitbook.io/prometheus/).
79

8-
This is currently work in Progress and far from finished.
10+
## Installation
11+
To install Prometheus, simply clone the Github Repository using:
12+
13+
```batch
14+
git clone https://github.com/Levno710/Prometheus.git
15+
```
16+
17+
Alternatively you can download the Sources [here](https://github.com/Levno710/Prometheus/archive/refs/heads/master.zip).
18+
19+
Prometheus also Requires LuaJIT or Lua51 in order to work. The Lua51 binaries can be downloaded [here](https://sourceforge.net/projects/luabinaries/files/5.1.5/Tools%20Executables/).
20+
## Usage
21+
Prometheus provides a simple cli for obfuscating scripts. It can be used as following:
22+
```batch
23+
lua ./cli.lua [options] ./your_file.lua
24+
```
25+
## Tests
26+
To perform the Prometheus Tests, just run
27+
```batch
28+
lua ./tests.lua
29+
```
30+
## Credits
31+
### Contributors
32+
- [levno-710](https://github.com/levno-710)
33+
### Libraries Used
34+
- [lua-bit-numberlua](https://github.com/davidm/lua-bit-numberlua)
35+
## License
36+
This Project is Licensed under the GNU General Public License v3.0. For more details, please refer to [LICENSE](https://github.com/levno-710/Prometheus/blob/master/LICENSE).

0 commit comments

Comments
 (0)