Skip to content

Commit

Permalink
Some updates to readme and license
Browse files Browse the repository at this point in the history
  • Loading branch information
mkj committed Mar 3, 2024
1 parent be668c5 commit 8e6f037
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
7 changes: 6 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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

Expand Down Expand Up @@ -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.

0 comments on commit 8e6f037

Please sign in to comment.