aboutsummaryrefslogtreecommitdiffstats
path: root/readme.rst
diff options
context:
space:
mode:
authorVG <vg@devys.org>2016-12-09 11:08:23 +0100
committerVG <vg@devys.org>2016-12-09 11:08:23 +0100
commitc7a845d942c25e3e88d8c60afd17b9cab071e510 (patch)
treeb537dadf61534584bf42c859914d889e2013f547 /readme.rst
parent696bda031f200911448b08b86fb4669585f6ed55 (diff)
downloadclip-c7a845d942c25e3e88d8c60afd17b9cab071e510.tar.gz
clip-c7a845d942c25e3e88d8c60afd17b9cab071e510.tar.bz2
clip-c7a845d942c25e3e88d8c60afd17b9cab071e510.zip
add license and readme
Diffstat (limited to 'readme.rst')
-rw-r--r--readme.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/readme.rst b/readme.rst
new file mode 100644
index 0000000..4f2eafe
--- /dev/null
+++ b/readme.rst
@@ -0,0 +1,46 @@
+Description
+===========
+
+Simple clipboard storing anything from stdin in a file or outputing from
+the file to stdout. Direction is determined from pipe redirection.
+
+Usage
+=====
+
+Store something to clipboard::
+
+ $ echo abc | clip
+
+Output clipboard content to console::
+
+ $ clip
+
+Use content::
+
+ $ clip > file
+ $ clip | command
+
+Installation
+============
+
+Just copy clip script in your path (~/bin/ for example).
+
+License
+=======
+
+Unless specified otherwise, this project is licensed under the terms of the
+MIT license. You should have received a copy of the MIT License along with
+this program. If not, see <https://opensource.org/licenses/MIT>.
+
+SPDX-License-Identifier: MIT
+
+Copyright © 2016 vg <vg@devys.org>
+
+Contact
+=======
+
+developer
+ vg
+
+mail
+ vg@devys.org