Skip to content

Commit

Permalink
readme: spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
primalmotion committed May 9, 2023
1 parent ef97c5f commit 29ebb34
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# NetBoard
# Netboard

NetBoard is a client/server application that allows to share your clipboard
Netboard is a client/server application that allows to share your clipboard
between different devices. It works by deploying a server, then running client
on your devices to sync the clipboard.

Expand All @@ -10,8 +10,8 @@ possible to integrate it with anything else, like good old curl.

> NOTE: netboard is NOT multi tenant. While it is possible to add it if there is
> any interest in the matter, for now it just assumes that anyone connecting
> with a valid certificate is willing to get its clipboard sync with the rest of
> the instance.
> with a valid certificate is willing to get its clipboard synchronized with the
> rest of the instance.
## Installation

Expand All @@ -31,7 +31,7 @@ yay -S netboard-git

### Certificates

Netboard uses mutual tls to authenticate the clients. This is not optional, and
Netboard uses mutual TLS to authenticate the clients. This is not optional, and
you must generate several certificates:

- one certificate for the server (https)
Expand Down Expand Up @@ -81,7 +81,7 @@ tg cert \

Copy over the `netboard-server-cert.pem` and `netboard-server-key.pem`, as well
as the `netboard-client-ca-cert.pem` to the machine hosting the server. We will
put them in /etc/netboard. Then write a `config.yaml` file with the following
put them in `/etc/netboard`. Then write a `config.yaml` file with the following
content:

```yaml
Expand All @@ -99,8 +99,8 @@ netboard server

### Clients

Copy the client certificate to the approriate devices, in ~/.config/netboard,
then write a config.yaml file with the following content:
Copy the client certificate to the appropriate devices, in `~/.config/netboard`,
then write a `config.yaml` file with the following content:

```yaml
listen:
Expand Down

0 comments on commit 29ebb34

Please sign in to comment.