From 6b5186b503fb135657f08f065f7e33f738fc4baf Mon Sep 17 00:00:00 2001 From: MedzikUser Date: Sun, 18 Sep 2022 14:57:49 +0200 Subject: [PATCH] chore(readme): update --- README.md | 47 ++++++++++++--------------------------------- src/main.rs | 23 ---------------------- src/types/config.rs | 3 ++- 3 files changed, 14 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index 108da4c..c4f5564 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,13 @@ -# HomeDisk cloud server +

+ HomeDisk Icon +

-> **Warning** -> Currently, work on the project is suspended because I'm not good at frontend and don't have time :( - -[docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs -[total-lines]: https://img.shields.io/tokei/lines/github/MedzikUser/HomeDisk?style=for-the-badge&logo=github&color=fede00 -[code-size]: https://img.shields.io/github/languages/code-size/MedzikUser/HomeDisk?style=for-the-badge&color=c8df52&logo=github -[ci]: https://img.shields.io/github/workflow/status/MedzikUser/HomeDisk/Rust/main?style=for-the-badge - -[screenshot-home]: https://raw.githubusercontent.com/HomeDisk/.github/main/screenshots/home.png -[screenshot-login]: https://raw.githubusercontent.com/HomeDisk/.github/main/screenshots/login.png - -[![docs-rs]](https://homedisk-doc.vercel.app) -[![total-lines]](https://github.com/MedzikUser/HomeDisk) -[![code-size]](https://github.com/MedzikUser/HomeDisk) -[![ci]](https://github.com/MedzikUser/HomeDisk/actions/workflows/rust.yml) - -![screenshot-home] - -![screenshot-login] - -## 👨‍💻 Building - -First clone the repository: `git clone https://github.com/MedzikUser/HomeDisk.git` - -### Requirements -- Rust - -To build run the command: `cargo build --release` - -The compiled binary can be found in `./target/release/homedisk` - -## Configure - -Go to [config](https://homedisk-doc.medzik.xyz/homedisk_types/config) module +

+ +   + +   + +   + +

diff --git a/src/main.rs b/src/main.rs index eed5d22..ba65535 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,31 +1,8 @@ //! HomeDisk cloud server //! //! [github]: https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github -//! [docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs -//! [total-lines]: https://img.shields.io/tokei/lines/github/MedzikUser/HomeDisk?style=for-the-badge&logo=github&color=fede00 -//! [code-size]: https://img.shields.io/github/languages/code-size/MedzikUser/HomeDisk?style=for-the-badge&color=c8df52&logo=github -//! [ci]: https://img.shields.io/github/workflow/status/MedzikUser/HomeDisk/Rust/main?style=for-the-badge -//! -//! [home-screenshot]: https://raw.githubusercontent.com/HomeDisk/.github/main/screenshots/home.png //! //! [![github]](https://github.com/MedzikUser/HomeDisk) -//! [![docs-rs]](https://homedisk-doc.vercel.app) -//! [![total-lines]](https://github.com/MedzikUser/HomeDisk) -//! [![code-size]](https://github.com/MedzikUser/HomeDisk) -//! [![ci]](https://github.com/MedzikUser/HomeDisk/actions/workflows/rust.yml) -//! -//! ![home-screenshot] -//! -//! ## 👨‍💻 Building -//! -//! First clone the repository: `git clone https://github.com/MedzikUser/HomeDisk.git` -//! -//! ### Requirements -//! - [Rust](https://rust-lang.org) -//! -//! To build run the command: `cargo build --release` -//! -//! The compiled binary can be found in `./target/release/homedisk` //! //! ## Configure //! diff --git a/src/types/config.rs b/src/types/config.rs index b49c5fd..14b6ba5 100644 --- a/src/types/config.rs +++ b/src/types/config.rs @@ -1,4 +1,5 @@ -//! [Configuration file types](Config). +//! [Configuration file types](Config) + use std::fs; use serde::{Deserialize, Serialize};