update README.md

Author: neevek

Cargo.lock

@@ -2,3 +2,63 @@ fileserver-rs
 =============
 
 Simple file server written in Rust.
+
+![fileserver-rs](https://github.com/neevek/fileserver-rs/raw/master/screenshot/screenshot.jpg)
+
+Build from source
+-----------------
+
+1. build the `frontend` crate:
+
+  `frontend` will be built with the `trunk` program, which can be installed with `cargo install trunk`, see [trunkrs.dev](https://trunkrs.dev/) for details. 
+
+  ```
+  cd frontend
+  trunk build --release --public-url '/assets'
+  ```
+
+  The `index.html` file and the generated wasm files will be copied to `frontend/dist`, these files will be used to render the frontend UI, to interact with the backend server.
+
+
+2. build the `backend` crate:
+
+  `cargo build --release --bin fileserver-rs`
+
+  output of the `backend` crate is named `fileserver-rs`, which will be built as a command line app and located at `target/release/fileserver-rs`:
+
+
+  ```
+  A static file server that supports upload/create dir/delete/qrcode
+
+  Usage: fileserver-rs [OPTIONS]
+
+  Options:
+    -l, --log <LOG_LEVEL>          Log level [default: debug]
+    -a, --addr <ADDR>              Listen addr [default: 0.0.0.0]
+    -p, --port <PORT>              Listen port [default: 8888]
+        --assets-dir <ASSETS_DIR>  Directory where the wasm files built from the frontend sub crate are located [default: ./frontend/dist]
+        --serve-dir <SERVE_DIR>    Directory to serve, default to the current directory if not specified [default: .]
+    -h, --help                     Print help information
+
+  ```
+
+Run the server
+--------------
+
+Run the server to serve the `target` directory (this is for test):
+
+`
+./target/release/fileserver-rs -p 8888 --assets-dir ./frontend/dist --serve-dir ./target
+`
+
+Now the server is started at `http://localhost:8888/`.
+
+MIT License
+-------
+Copyright 2022 Jiamin.Xie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,5 +1,5 @@
 [package]
-name = "backend"
+name = "fileserver-rs"
 version = "0.1.0"
 edition = "2021"
 

backend/Cargo.toml

@@ -26,27 +26,29 @@ use walkdir::WalkDir;
 
 static mut SERVE_DIR: Option<PathBuf> = None;
 
-// Setup the command line interface with clap.
 #[derive(Parser, Debug)]
-#[clap(name = "server", about = "A server for our wasm project!")]
+#[clap(
+    name = "fileserver-rs",
+    about = "A static file server that supports upload/create dir/delete/qrcode"
+)]
 struct Opt {
-    /// set the log level
+    /// Log level
     #[clap(short = 'l', long = "log", default_value = "debug")]
     log_level: String,
 
-    /// set the listen addr
+    /// Listen addr
     #[clap(short = 'a', long = "addr", default_value = "0.0.0.0")]
     addr: String,
 
-    /// set the listen port
-    #[clap(short = 'p', long = "port", default_value = "8080")]
+    /// Listen port
+    #[clap(short = 'p', long = "port", default_value = "8888")]
     port: u16,
 
-    /// set the directory where static files are to be found
-    #[clap(long = "assets-dir", default_value = "../assets")]
+    /// Directory where the wasm files built from the frontend sub crate are located
+    #[clap(long = "assets-dir", default_value = "./frontend/dist")]
     assets_dir: String,
 
-    /// the directory to serve, default to the current directory if not specified
+    /// Directory to serve, default to the current directory if not specified
     #[clap(long = "serve-dir", default_value = ".")]
     serve_dir: String,
 }