Add readme and license

COPYING

@@ -0,0 +1,95 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copyin

README.md

@@ -1,35 +1,58 @@
-# Merenda - Byte-sized snacks over SSH.
+# Merenda - Byte-sized snacks over SSH
 
 A tiny server/client application to synchronize clipboards over SSH in Rust, inspired by similar tools like [Lemonade](https://github.com/pocke/lemonade).
 
 # Installation
 
-On Arch Linux, you can install `merenda` from the AUR. For example, with yay:
-```
-yay merenda
-```
-
-Or you can install it through cargo:
 ```
 cargo install merenda
 ```
 
 ## Local setup
 
-After installation, run `merenda server` on your main machine - the one you'll use to SSH onto other systems. It will listen for connections requesting to read/write your clipboard, and you'll generally want to have it running in the background. On its own, it also works as a roundabout way to read/write your clipboard, by using `merenda get` and `merenda set`.
+After installation, run `merenda server` on your main machine - the one you'll use to SSH into other systems. It will listen for connections requesting to read/write your clipboard, and you'll generally want to have it running in the background. On its own, it also works as a roundabout way to read/write your clipboard, by using `merenda get` and `merenda set` on your local machine.
+
+If you're using systemd, you can copy the [provided user service](examples/merenda.service) to `~/.config/systemd/user`, which you can activate with `systemctl --user start merenda.service` and enable at boot with `systemctl --user enable merenda.service`.
 
-The Arch package comes with a systemd user unit, which you can activate with `systemctl --user start merenda.service` and enable at boot with `systemctl --user enable merenda.service`.
 By default, the server will listen on `127.0.0.1`, port 3660. You can change either with the `-H/--address` and `-p/--port` arguments.
 
-*CAUTION: Think carefully before changing the default listen address*. Merenda has absolutely no authentication, so listening on anything other than loopback will allow anyone able to reach that IP address to read/write to your clipboard at will. A safer alternative is to set up an SSH local reverse port forwarding, so that the port is exposed only on the other end of the SSH connection. More on that later.
+*CAUTION: Think carefully before changing the default listen address*. Merenda has absolutely no authentication or encryption, so listening on anything other than loopback will allow anyone able to reach that IP address to read/write to your clipboard at will. A safer alternative is to set up an SSH local reverse port forwarding, so that the port is exposed only on the other end of the SSH connection. More on that later.
 
 ## Remote setup
 
 After installation, set up your preferred editors/tools to use merenda to store data to the clipboard when an SSH connection is available.
 For example, I use NeoVim and my config looks like this:
 ```
-.
+if !empty($SSH_CONNECTION)
+    set clipboard+=unnamed
+    let g:clipboard= {
+        \   'name': 'merenda',
+        \   'copy': {
+        \       '*': ['merenda', 'set'],
+        \   },
+        \   'paste': {
+        \       '*': ['merenda', 'get'],
+        \   },
+        \   'cache_enabled': 1,
+        \ }
+endif
 ```
 
-## Forwarding the 
+## Forwarding over SSH
+
+You can forward the port merenda is listening on to your remote host by adding a `RemoteForward` option to your `~/.ssh/config` file.
+
+For example:
+
+```
+Host myothercomputer
+    User username
+    RemoteForward 3660 localhost:3660
+    Hostname 10.1.1.251
+```
+
+Now you can use `merenda set` and `merenda get` to read/write the clipboard from the remote host!
+
+## License
 
+This project and all contributions to it are licensed under the GPL General Public License v3.

examples/merenda.service

@@ -0,0 +1,11 @@
+[Unit]
+Description=Merenda - Byte-sized snacks over SSH
+StartLimitIntervalSec=5
+StartLimitBurst=10
+
+[Service]
+ExecStart="%h/.cargo/bin/merenda" server
+Restart=on-failure
+
+[Install]
+WantedBy=default.target