From 17a4ab5fb8ca78fb3cb1787eed2ae8554f323a12 Mon Sep 17 00:00:00 2001 From: LoveJesus Date: Tue, 6 Aug 2024 10:34:02 -0600 Subject: [PATCH] HALLELUJAH fixed metadata , license and readme.md --- Cargo.toml | 12 +++++++++ LICENSE | 23 +++++++++++++++++ README.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++++------ 3 files changed, 101 insertions(+), 7 deletions(-) create mode 100644 LICENSE diff --git a/Cargo.toml b/Cargo.toml index 372dbea..084885a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,6 +3,14 @@ name = "rs_machine_input_chirho" version = "0.1.0" edition = "2021" +authors = ["Love Jesus "] +description = "A command-line tool to synchronize computer resource information with a remote database" +readme = "README.md" +homepage = "https://gitea-aleluya.prd.pw/loveJesus/rs_machine_input_chirho.git" +repository = "https://gitea-aleluya.prd.pw/loveJesus/rs_machine_input_chirho.git" +license = "MIT" +keywords = ["system-info", "synchronization", "database"] +categories = ["command-line-utilities", "system"] [dependencies] chrono = { version="0.4.38", features=["serde"] } @@ -29,3 +37,7 @@ sys-info = "0.9" [target.'cfg(any(target_os = "windows", target_os = "macos"))'.dependencies] sysinfo = "0.23" + +[[bin]] +name = "rs_machine_input_chirho" +path = "src/main.rs" \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9ce0a4a --- /dev/null +++ b/LICENSE @@ -0,0 +1,23 @@ +For God so loved the world, that He gave His only begotten Son, that all who believe in Him should not perish but have everlasting life + +MIT License + +Copyright (c) [year] [fullname] + +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. \ No newline at end of file diff --git a/README.md b/README.md index ea6ae14..9017cc6 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,81 @@ # For God so loved the world, that He gave His only begotten Son, that all who believe in Him should not perish but have everlasting life -## rs_machine_input_chirho +# rs_machine_input_chirho -This command line application is intended to keep a remote database of computer resources synchronized -with the information about those resources. +A command-line application designed to synchronize computer resource information with a remote database. -run the following command from the project base to create the server side DB: +## Features + +- Collects system information from Linux, Windows, and macOS machines +- Sends data to a remote server using a REST API +- Stores information in a SQLite database + +## Installation + +To install `rs_machine_input_chirho`, you need to have Rust and Cargo installed on your system. Then, you can install it using: + +```bash +cargo install rs_machine_input_chirho +``` + +## Usage + +1. Set up the server-side database: ```bash sql_chirho/createdb_chirho.sh ``` -we also need the environment variables in dot.env_chirho.sample_chirho properly set up in both the client and the -server. +2. Configure environment variables: + - Copy `dot.env_chirho.sample_chirho` to `.env_chirho` on both client and server + - Edit the `.env_chirho` file to set the appropriate values + +3. if desired to change from the default 8870 set the server port: + +```bash +export ROCKET_PORT= +``` + +4. Run the application as a server: + +```bash +rs_machine_input_chirho +``` + +or run as a client providing the destination server url + +```bash +rs_machine_input_chirho --cli-url-chirho +``` + +## Development + +To contribute to this project: + +1. Clone the repository +2. Install dependencies: `cargo build` +3. Run tests: `cargo test` +4. Submit a pull request with your changes + +## Development Configuration + +The application uses a `rocket.toml` file for server configuration. You can modify this file to change server settings like address, port, and database URL. -`export ROCKET_PORT=...` to set the port where the server will listen to requests. +## License +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. +## Contact +For any questions or issues, please open an issue on the GitHub repository. +## A Message of Hope, The Gospel +At the heart of the Christian faith lies a message of hope and love: God, in His infinite love, +sent His Son Jesus Christ to bridge the gap between humanity and Himself. +Through Jesus' life, death on the cross, and resurrection, He offers forgiveness of +sins and eternal life to all who believe in Him. This gift of salvation is freely available +to everyone who puts their trust in Jesus, regardless of their past or present circumstances. +As John 3:16 beautifully states, "For God so loved the world, that He gave His only begotten Son, +that whoever believes in Him shall not perish, but have eternal life." He is alive and still does +miracles and hasn't changed. If you seek Him, you will find Him. He is a prayer away.