You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by tw...@apache.org on 2022/10/29 15:48:16 UTC
[mina-sshd] branch master updated: Slightly rewrite the intro blurb
This is an automated email from the ASF dual-hosted git repository.
twolf pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mina-sshd.git
The following commit(s) were added to refs/heads/master by this push:
new 1fc7e0e3c Slightly rewrite the intro blurb
1fc7e0e3c is described below
commit 1fc7e0e3cc0de95cf0a3862a8ff8ab38fba18b45
Author: Thomas Wolf <tw...@apache.org>
AuthorDate: Sat Oct 29 16:00:29 2022 +0200
Slightly rewrite the intro blurb
Also mention the built-in NIO2 transport, and that Netty can be used.
---
README.md | 13 +++++++++----
1 file changed, 9 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index a90170ff1..0b6305e18 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,16 @@
# Apache MINA SSHD
-Apache SSHD is a 100% pure java library to support the SSH protocols on both the client and server side. This library can
-leverage [Apache MINA](http://mina.apache.org), a scalable and high performance asynchronous IO library. SSHD does not really
+Apache MINA SSHD is a 100% pure java library to support the SSH protocols on both the client and server side. It does not
aim at being a replacement for the SSH client or SSH server from Unix operating systems, but rather provides support for Java
based applications requiring SSH support.
+The library can leverage several I/O back-ends:
+
+* The default transport is built-in and uses Java's `AsynchronousSocketChannel`s.
+* [Apache MINA](https://mina.apache.org), a scalable and high performance asynchronous I/O library, can be used instead, or
+* the [Netty](https://netty.io) asynchronous event-driven network framework is also supported.
+
# Supported standards
## Reference implementation documentation
@@ -49,7 +54,7 @@ based applications requiring SSH support.
* `newline` - [DRAFT 09 Section 4.3](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-09#section-4.3)
* `md5-hash`, `md5-hash-handle` - [DRAFT 09 - section 9.1.1](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-09#section-9.1.1)
* `check-file-handle`, `check-file-name` - [DRAFT 09 - section 9.1.2](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-09#section-9.1.2)
- * `copy-file`, `copy-data` - [DRAFT 00 - sections 6, 7](http://tools.ietf.org/id/draft-ietf-secsh-filexfer-extensions-00.txt)
+ * `copy-file`, `copy-data` - [DRAFT 00 - sections 6, 7](https://tools.ietf.org/id/draft-ietf-secsh-filexfer-extensions-00.txt)
* `space-available` - [DRAFT 09 - section 9.2](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-09#section-9.2)
* `filename-charset`, `filename-translation-control` - [DRAFT 13 - section 6](https://tools.ietf.org/html/draft-ietf-secsh-filexfer-13#section-6) - only client side
* Several [OpenSSH SFTP extensions](https://github.com/openssh/openssh-portable/blob/master/PROTOCOL)
@@ -139,7 +144,7 @@ Sensitive issues such as security vulnerabilities must be reported through [priv
* Java 8+ (as of version 1.3)
-* [Slf4j](http://www.slf4j.org/)
+* [Slf4j](https://www.slf4j.org/)
The code only requires the core abstract [slf4j-api](https://mvnrepository.com/artifact/org.slf4j/slf4j-api) module. The actual
implementation of the logging API can be selected from the many existing adaptors.