commit 87dcf7a9c91dd67ce19c86bcf45b02c88b357c78
parent 5db3b00dd7487f26ca643fa53344882136e18e76
Author: Nihal Jere <nihal@nihaljere.xyz>
Date: Thu, 24 Feb 2022 13:01:25 -0600
add LICENSE and README
Diffstat:
2 files changed, 40 insertions(+), 0 deletions(-)
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,13 @@
+Copyright 2022 Nihal Jere <nihal@nihaljere.xyz>
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,27 @@
+# wayclip
+
+wayclip is a pair of command-line utilities: `waycopy` and `waypaste`,
+which allow access to the Wayland clipboard. Specifically, `wayclip`
+is a `wlr-data-control` protocol client.
+
+wayclip distinguishes itself from other Wayland clipboard utilities
+in the following ways:
+- small - the whole codebase is less than 300 lines! (excluding whitespace)
+- Unixy - all it does is copy and paste; other functions are for other programs
+- no dynamic memory allocation
+
+## Usage
+
+To copy data, just pipe it into `waycopy`, and optionally specify a seat and mimetype:
+
+```
+$ echo "howdy" | waycopy -s seat0 -t text/plain &
+```
+(note that `waycopy` does not automatically fork into the background)
+
+To paste, optionally specify a seat and desired mimetype:
+```
+$ waypaste -s seat0 -t text/plain
+howdy
+$
+```
