From 3225471e2852e0996d7b6221ca80e40c76980534 Mon Sep 17 00:00:00 2001 From: Chip Senkbeil Date: Thu, 1 Jun 2023 02:21:25 -0500 Subject: [PATCH] Add some basic readmes --- Makefile.toml | 38 +++++++++++++++++++++++++++++++++ distant-auth/README.md | 35 +++++++++++++++++++++++++++++++ distant-local/README.md | 43 ++++++++++++++++++++++++++++++++++++++ distant-net/README.md | 5 ----- distant-protocol/README.md | 35 +++++++++++++++++++++++++++++++ 5 files changed, 151 insertions(+), 5 deletions(-) create mode 100644 Makefile.toml create mode 100644 distant-auth/README.md create mode 100644 distant-local/README.md create mode 100644 distant-protocol/README.md diff --git a/Makefile.toml b/Makefile.toml new file mode 100644 index 00000000..c71c87ae --- /dev/null +++ b/Makefile.toml @@ -0,0 +1,38 @@ +[tasks.format] +install_crate = "rustfmt-nightly" +command = "cargo" +args = ["+nightly", "fmt", "--all"] + +[tasks.test] +command = "cargo" +args = ["test", "--release", "--all-features", "--workspace"] + +[tasks.ci-test] +command = "cargo" +args = ["nextest", "run", "--profile", "ci", "--release", "--all-features", "--workspace"] + +[tasks.post-ci-test] +command = "cargo" +args = ["test", "--release", "--all-features", "--workspace", "--doc"] + +[tasks.publish] +script = ''' +cargo publish --all-features -p distant-auth +cargo publish --all-features -p distant-protocol +cargo publish --all-features -p distant-net +cargo publish --all-features -p distant-core +cargo publish --all-features -p distant-local +cargo publish --all-features -p distant-ssh2 +cargo publish --all-features +''' + +[tasks.dry-run-publish] +script = ''' +cargo publish --all-features --dry-run -p distant-auth +cargo publish --all-features --dry-run -p distant-protocol +cargo publish --all-features --dry-run -p distant-net +cargo publish --all-features --dry-run -p distant-core +cargo publish --all-features --dry-run -p distant-local +cargo publish --all-features --dry-run -p distant-ssh2 +cargo publish --all-features --dry-run +''' diff --git a/distant-auth/README.md b/distant-auth/README.md new file mode 100644 index 00000000..4f79e683 --- /dev/null +++ b/distant-auth/README.md @@ -0,0 +1,35 @@ +# distant auth + +[![Crates.io][distant_crates_img]][distant_crates_lnk] [![Docs.rs][distant_doc_img]][distant_doc_lnk] [![Rustc 1.64.0][distant_rustc_img]][distant_rustc_lnk] + +[distant_crates_img]: https://img.shields.io/crates/v/distant-auth.svg +[distant_crates_lnk]: https://crates.io/crates/distant-auth +[distant_doc_img]: https://docs.rs/distant-auth/badge.svg +[distant_doc_lnk]: https://docs.rs/distant-auth +[distant_rustc_img]: https://img.shields.io/badge/distant_auth-rustc_1.64+-lightgray.svg +[distant_rustc_lnk]: https://blog.rust-lang.org/2022/09/22/Rust-1.64.0.html + +## Details + +The `distant-auth` library supplies the authentication functionality for the +distant interfaces and distant cli. + +## Installation + +You can import the dependency by adding the following to your `Cargo.toml`: + +```toml +[dependencies] +distant-auth = "0.20" +``` + +## License + +This project is licensed under either of + +Apache License, Version 2.0, (LICENSE-APACHE or +[apache-license][apache-license]) MIT license (LICENSE-MIT or +[mit-license][mit-license]) at your option. + +[apache-license]: http://www.apache.org/licenses/LICENSE-2.0 +[mit-license]: http://opensource.org/licenses/MIT diff --git a/distant-local/README.md b/distant-local/README.md new file mode 100644 index 00000000..a44fa416 --- /dev/null +++ b/distant-local/README.md @@ -0,0 +1,43 @@ +# distant local + +[![Crates.io][distant_crates_img]][distant_crates_lnk] [![Docs.rs][distant_doc_img]][distant_doc_lnk] [![Rustc 1.64.0][distant_rustc_img]][distant_rustc_lnk] + +[distant_crates_img]: https://img.shields.io/crates/v/distant-local.svg +[distant_crates_lnk]: https://crates.io/crates/distant-local +[distant_doc_img]: https://docs.rs/distant-local/badge.svg +[distant_doc_lnk]: https://docs.rs/distant-local +[distant_rustc_img]: https://img.shields.io/badge/distant_local-rustc_1.64+-lightgray.svg +[distant_rustc_lnk]: https://blog.rust-lang.org/2022/09/22/Rust-1.64.0.html + +## Details + +The `distant-local` library acts as the primary implementation of a distant +server that powers the CLI. The logic acts on the local machine of the server +and is designed to be used as the foundation for distant operation handling. + +## Installation + +You can import the dependency by adding the following to your `Cargo.toml`: + +```toml +[dependencies] +distant-local = "0.20" +``` + +## Examples + +```rust +// Create a server API handler to be used with the server +let handler = distant_local::initialize_handler().unwrap(); +``` + +## License + +This project is licensed under either of + +Apache License, Version 2.0, (LICENSE-APACHE or +[apache-license][apache-license]) MIT license (LICENSE-MIT or +[mit-license][mit-license]) at your option. + +[apache-license]: http://www.apache.org/licenses/LICENSE-2.0 +[mit-license]: http://opensource.org/licenses/MIT diff --git a/distant-net/README.md b/distant-net/README.md index 06f097fb..f31c71be 100644 --- a/distant-net/README.md +++ b/distant-net/README.md @@ -9,11 +9,6 @@ [distant_rustc_img]: https://img.shields.io/badge/distant_net-rustc_1.64+-lightgray.svg [distant_rustc_lnk]: https://blog.rust-lang.org/2022/09/22/Rust-1.64.0.html -Library that powers the [`distant`](https://github.com/chipsenkbeil/distant) -binary. - -🚧 **(Alpha stage software) This library is in rapid development and may break or change frequently!** 🚧 - ## Details The `distant-net` library supplies the foundational networking functionality diff --git a/distant-protocol/README.md b/distant-protocol/README.md new file mode 100644 index 00000000..c56a9182 --- /dev/null +++ b/distant-protocol/README.md @@ -0,0 +1,35 @@ +# distant protocol + +[![Crates.io][distant_crates_img]][distant_crates_lnk] [![Docs.rs][distant_doc_img]][distant_doc_lnk] [![Rustc 1.64.0][distant_rustc_img]][distant_rustc_lnk] + +[distant_crates_img]: https://img.shields.io/crates/v/distant-protocol.svg +[distant_crates_lnk]: https://crates.io/crates/distant-protocol +[distant_doc_img]: https://docs.rs/distant-protocol/badge.svg +[distant_doc_lnk]: https://docs.rs/distant-protocol +[distant_rustc_img]: https://img.shields.io/badge/distant_protocol-rustc_1.64+-lightgray.svg +[distant_rustc_lnk]: https://blog.rust-lang.org/2022/09/22/Rust-1.64.0.html + +## Details + +The `distant-protocol` library supplies the structs and enums that make up the +messaging structure for distant. + +## Installation + +You can import the dependency by adding the following to your `Cargo.toml`: + +```toml +[dependencies] +distant-protocol = "0.20" +``` + +## License + +This project is licensed under either of + +Apache License, Version 2.0, (LICENSE-APACHE or +[apache-license][apache-license]) MIT license (LICENSE-MIT or +[mit-license][mit-license]) at your option. + +[apache-license]: http://www.apache.org/licenses/LICENSE-2.0 +[mit-license]: http://opensource.org/licenses/MIT