Skip to content

Commit 003a081

Browse files
authored
Update README with Quick Start and section adjustments
Reorganized README sections and added Quick Start instructions for better clarity.
1 parent 5022712 commit 003a081

1 file changed

Lines changed: 20 additions & 26 deletions

File tree

README.md

Lines changed: 20 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@
2525

2626
---
2727

28-
## About
28+
<p align="center">
29+
<img src="assets/readme/obfuscation-preview.gif" alt="Prometheus obfuscation process preview" width="900" />
30+
</p>
2931

3032
**Prometheus** is a Lua obfuscator written in pure Lua.
3133

@@ -41,11 +43,24 @@ Currently, Prometheus supports:
4143

4244
---
4345

44-
## Preview
4546

46-
<p align="center">
47-
<img src="assets/readme/obfuscation-preview.gif" alt="Prometheus obfuscation process preview" width="900" />
48-
</p>
47+
## Quick Start
48+
49+
Clone the repository:
50+
51+
```bash
52+
git clone https://github.com/prometheus-lua/Prometheus.git
53+
cd Prometheus
54+
```
55+
56+
Alternatively, you can download the sources directly [here](https://github.com/prometheus-lua/Prometheus/archive/refs/heads/master.zip).
57+
58+
59+
To obfuscate a script, run:
60+
61+
```bash
62+
lua ./cli.lua --preset Medium ./your_file.lua
63+
```
4964

5065
---
5166

@@ -98,17 +113,6 @@ You can find the full documentation, including the getting started guide, here:
98113

99114
---
100115

101-
## Installation
102-
103-
Clone the repository:
104-
105-
```bash
106-
git clone https://github.com/prometheus-lua/Prometheus.git
107-
cd Prometheus
108-
```
109-
110-
Alternatively, you can download the sources directly [here](https://github.com/prometheus-lua/Prometheus/archive/refs/heads/master.zip).
111-
112116
### Requirements
113117

114118
Prometheus requires **LuaJIT** or **Lua 5.1** in order to run.
@@ -118,16 +122,6 @@ https://sourceforge.net/projects/luabinaries/files/5.1.5/Tools%20Executables/
118122

119123
---
120124

121-
## Quick Start
122-
123-
To quickly obfuscate a script, run:
124-
125-
```bash
126-
lua ./cli.lua --preset Medium ./your_file.lua
127-
```
128-
129-
---
130-
131125
## Example
132126

133127
### Input

0 commit comments

Comments
 (0)