Skip to content
This repository was archived by the owner on Nov 24, 2024. It is now read-only.

Commit c9814d5

Browse files
committed
Updated README
1 parent 92ed445 commit c9814d5

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,35 +8,36 @@
88

99
</h1>
1010

11-
<h3>
12-
<strong>V2RayGen / XRayGen</strong> is a fully automated script that helps you to set up your own Xray server in the fastest time.
13-
</h3>
11+
<h3><strong>V2RayGen/XRayGen</strong>: A Fast and Automated Script for XRay/V2Ray Server Setup</h3>
1412

1513
[**Usage**](#usage)
1614

1715
[**Quick Setup**](#quicksetup)
1816

1917
[**Examples**](#examples)
2018

21-
[**Options ⚙️**](#options)
19+
[**Options**](#options)
2220

23-
[**License 🪪**](#license)
21+
[**License**](#license)
2422

25-
[**Donate Me**](#donateme)
23+
[**Donate Me**](#donateme)
2624

2725
## **Prerequisites & Dependencies**
2826

29-
For running this script, you must have **docker**, **docker-compose** and **python3** on your server **but** this script installs `docker` & `docker-compose` if your server doesn't have docker and runs xray-core automatically
27+
- `Python3`
28+
- `Docker`
29+
- `Docker Compose`
30+
<p>If your server lacks Docker and Docker-Compose, the script will install them and launch XRay-Core automatically.</p>
3031

3132
use **sudo** if your current user is not in the docker group or you don't have docker installed
3233

33-
## **How XRayGen Works ?**
34+
## **How Does XRayGen Work?**
3435

35-
`XRayGen` uses docker to pull XRay image from the docker registry and after that, it generates a configuration file to start XRay container.
36+
<p>XRayGen uses Docker to retrieve the xray-core image from the Docker registry. It then generates a configuration file to launch the XRay container.
3637

37-
it also creates a client side configuration file so you can use that with xray-core or v2ray-core.
38+
A client-side configuration file is also created for use with XRay-core or V2Ray-core.
3839

39-
There is also `XRayAgent` for User Management on XRay Configuration which can be used for CRUD operations.
40+
The XRayAgent provides user management for XRay configuration, offering CRUD operations.</p>
4041

4142
## **Usage**
4243

0 commit comments

Comments
 (0)