Skip to content

Commit

Permalink
fix: typos (#156)
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesreprise authored Jul 21, 2023
1 parent 0d4efc7 commit ab47213
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 11 deletions.
18 changes: 10 additions & 8 deletions README.md
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,14 @@
Make SSH apps, just like that! 💫

SSH is an excellent platform to build remotely accessible applications on. It
offers secure communication without the hassle of HTTPS certificates, it has
user identification with SSH keys and it's accessible from anywhere with a
terminal. Powerful protocols like Git work over SSH and you can even render
TUIs directly over an SSH connection.
offers:
* secure communication without the hassle of HTTPS certificates
* user identification with SSH keys
* accessiblity from anywhere with a terminal

Wish is an SSH server with sensible defaults and a collection of middleware that
Powerful protocols like Git work over SSH and you can even render TUIs directly over an SSH connection.

Wish is an SSH server with sensible defaults and a collection of middlewares that
makes building SSH apps easy. Wish is built on [gliderlabs/ssh][gliderlabs/ssh]
and should be easy to integrate into any existing projects.

Expand All @@ -34,7 +36,7 @@ It is a cryptographic network protocol for operating network services securely o

[^1]: https://en.wikipedia.org/wiki/Secure_Shell

That means, among other things, that we can write custom SSH servers, without touching `openssh-server`,
That means, among other things, that we can write custom SSH servers without touching `openssh-server`,
so we can securely do more things than just providing a shell.

Wish is a library that helps writing these kind of apps using Go.
Expand Down Expand Up @@ -114,7 +116,7 @@ Host localhost
## How it works?

Wish uses [gliderlabs/ssh][gliderlabs/ssh] to implement its SSH server, and
the OpenSSH is never used nor needed — you can even uninstall it if you want to.
OpenSSH is never used nor needed — you can even uninstall it if you want to.

Incidentally, there's no risk of accidentally sharing a shell because there's no
default behavior that does that on Wish.
Expand All @@ -141,7 +143,7 @@ Restart=on-failure
WantedBy=multi-user.target
```

You can tune the values bellow, and once you're happy with them, you can run:
You can tune the values below, and once you're happy with them, you can run:

```bash
# need to run this every time you change the unit file
Expand Down
6 changes: 3 additions & 3 deletions options.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ func WithVersion(version string) ssh.Option {
}
}

// WithMiddleware composes the provided Middleware and return a ssh.Option.
// This useful if you manually create an ssh.Server and want to set the
// WithMiddleware composes the provided Middleware and returns an ssh.Option.
// This is useful if you manually create an ssh.Server and want to set the
// Server.Handler.
//
// Notice that middlewares are composed from first to last, which means the last one is executed first.
Expand Down Expand Up @@ -65,7 +65,7 @@ func WithHostKeyPEM(pem []byte) ssh.Option {
return ssh.HostKeyPEM(pem)
}

// WithAuthorizedKeys allows to use a SSH authorized_keys file to allowlist users.
// WithAuthorizedKeys allows the use of an SSH authorized_keys file to allowlist users.
func WithAuthorizedKeys(path string) ssh.Option {
return func(s *ssh.Server) error {
if _, err := os.Stat(path); err != nil {
Expand Down
Empty file modified options_test.go
100755 → 100644
Empty file.
Empty file modified wish_test.go
100755 → 100644
Empty file.

0 comments on commit ab47213

Please sign in to comment.