From 8e6f037ea9d9cc3e52b33b385a374368b17e624e Mon Sep 17 00:00:00 2001 From: Matt Johnston <matt@ucc.asn.au> Date: Sun, 3 Mar 2024 13:45:57 +0800 Subject: [PATCH] Some updates to readme and license --- LICENSE | 7 ++++++- README.md | 12 +++++++----- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/LICENSE b/LICENSE index 5d07d85..84c2eb5 100644 --- a/LICENSE +++ b/LICENSE @@ -1,8 +1,13 @@ -Sunset SSH is (c) 2022,2023 Matt Johnston and contributors +Sunset SSH is (c) 2022-2024 Matt Johnston and contributors licensed under BSD Zero Clause (0BSD) license below. -- +Dependencies have permissive licenses. Install and run `cargo license` to +get a summary. + +-- + Some demo code is from Embassy project under MIT or Apache-2.0 license. Copyright (c) 2019-2022 Embassy project contributors diff --git a/README.md b/README.md index 0333b19..6e1150f 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ embed pretty much anywhere, I'm collecting possible use cases in [discussions](https://github.com/mkj/sunset/discussions/1). Don't hesitate to suggest something! -** This software is incomplete but nearly ready to be used ** +**This software is in an early stage. It is suitable for some applications +but will certainly have API changes** - `sunset` (this toplevel) is the core SSH implementation. It provides a non-async API, runs with `no_std` and no alloc. @@ -23,9 +24,10 @@ suggest something! using about 15kB RAM per concurrent SSH session (max stack size not confirmed). - [`sunset-async`](async/) adds functionality to use Sunset as a normal SSH client or - server async library in normal Rust (not `no_std`). The - [examples](async/examples) include a Linux commandline SSH client. - This uses Tokio or async-std. + server async library in normal Rust (not `no_std`). This uses Tokio or async-std. + + The [examples](async/examples) include a Linux commandline SSH client `sunsetc`. + It works as a day-to-day SSH client. ## SSH Features @@ -69,4 +71,4 @@ will not be cleared. Matt Johnston <matt@ucc.asn.au> It's built on top of lots of other work, particularly Embassy, the rust-crypto crates, -Virtue, and Salty. +Virtue, smoltcp, and Salty. -- GitLab