Skip to content

Commit

Permalink
add introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
fankaiLiu committed Oct 10, 2023
1 parent d858a42 commit d800954
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@

# Salvo CLI

Salvo CLI is a command-line interface tool for the Salvo web framework. It helps streamline the process of setting up a new Salvo project by generating a template structure.
Salvo CLI is a command-line interface tool for the [Salvo](https://github.com/salvo-rs/salvo) web framework. It helps streamline the process of setting up a new Salvo project by generating a template structure.

## Installation

Before you can use the Salvo CLI, you need to install it. Assuming you have Rust and Cargo installed, you can install Salvo CLI with the following command:

```bash
cargo install salvo-cli
```
Expand All @@ -15,13 +14,24 @@ To create a new Salvo project, use the new command followed by the name of your
```bash
salvo-cli new project_name
```
This will create a new directory named project_name, and it will set up a basic project structure suitable for a Salvo-based application.

## Update
```bashs
cargo install --force salvo-cli
```

### Feature Development Plan

| Status |Task |
|:---:|:---:|
|| web api template |
|| web site with htmlx template |
||with sqlx template|
||basic midware |
||suport sqlite,pgsql,mysql|
||with seaorm template|
|| better web site |
|| with diese template|
|| with Rbatis template|
## License
This project is licensed under the MIT OR Apache-2.0 License.

Expand Down

0 comments on commit d800954

Please sign in to comment.