Update readme
This commit is contained in:
20
README.md
20
README.md
@ -2,6 +2,10 @@
|
||||
|
||||
**A script set for web services management.**
|
||||
|
||||
## Dependencies
|
||||
|
||||
- [astral uv: Python package manager](https://docs.astral.sh/uv/)
|
||||
|
||||
## Usage
|
||||
|
||||
- First clone the repository
|
||||
@ -11,14 +15,24 @@
|
||||
cd webscripts
|
||||
```
|
||||
|
||||
- Launch the manager with `main.py`
|
||||
- Initialize Python virtual environment and install dependencies
|
||||
```bash
|
||||
./main.py
|
||||
uv venv --python=3.12
|
||||
uv pip install -r requirement.txt
|
||||
```
|
||||
|
||||
- Launch the manager with `main.py`
|
||||
|
||||
>[!IMPORTANT]
|
||||
>If you have some reasons have to waste using uv, you should create virtual environment and install the dependencies manually, otherwise, it is recommended to use uv to manage those because of its convenience.
|
||||
|
||||
```bash
|
||||
uv run main.py
|
||||
```
|
||||
|
||||
Add `-h` as parameter to find usage:
|
||||
```bash
|
||||
./main.py -h
|
||||
uv run main.py -h
|
||||
usage: main.py [-h] {register,list,operate} ...
|
||||
|
||||
=====> Web Services Manager <=====
|
||||
|
@ -1,12 +1 @@
|
||||
[
|
||||
{
|
||||
"tag": "sys",
|
||||
"name": "nginx",
|
||||
"path": null
|
||||
},
|
||||
{
|
||||
"tag": "docker",
|
||||
"name": "homepage",
|
||||
"path": "/home/virtualguard/projects/webservices/homepage"
|
||||
}
|
||||
]
|
||||
[]
|
Reference in New Issue
Block a user