add readme

README.md

@@ -0,0 +1,2 @@
+# brevo
+URL shortener written in rust using the warp web server and MySQL

defaultconfig.toml

@@ -1,5 +1,8 @@
+# database URL including username, password, IP, port and database
 database_url = "mysql://brevo:brevo@127.0.0.1:3306/brevo"
-database = "brevo"
+# address to bind the HTTP server to
 bind_addr = "127.0.0.1:3001"
+# length of the suffix of shortened URLs
 link_len = 6
+# base URL where the service is reployed, used for displaying shortened URLs to users
 base_url = "http://127.0.0.1:3001/"

src/config.rs

@@ -7,7 +7,6 @@ use url::Url;
 pub struct Config {
     pub database_url: String,
     pub bind_addr: SocketAddr,
-    pub database: String,
     pub link_len: u8,
     pub base_url: Url,
 }