diff --git a/Cargo.toml b/Cargo.toml index c651a33..397093c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,8 +5,6 @@ edition = "2021" authors = ["mikesposito"] license = "MIT" -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html - [workspace] members = ["enclave"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b0affab --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Michele Esposito + +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 b/README.md similarity index 91% rename from README rename to README.md index 85dca44..72dd7eb 100644 --- a/README +++ b/README.md @@ -9,7 +9,15 @@ Secured is a versatile Rust package that provides robust encryption and decrypti ## Installation -To use **secured** as a CLI tool or integrate it into your Rust project, ensure you have Rust installed, then add Secured to your dependencies: +To use **secured** as a CLI tool or integrate it into your Rust project, ensure you have Rust installed, then: + +### As a CLI tool + +```sh +cargo install secured +``` + +### As a Library ```sh cargo add secured @@ -63,7 +71,3 @@ Contributions are welcome! Feel free to open issues or submit pull requests. ## License Secured is distributed under the MIT License. See `LICENSE` for more information. - ---- - -Feel free to modify and expand this README as per your project's evolving needs! \ No newline at end of file