aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Tim Segers <tsegers@pm.me>2025-11-01 11:08:20 +0100
committerGravatar Tim Segers <tsegers@pm.me>2025-11-07 14:03:27 +0100
commitbd2cb3a953fa8226d6d3805482d9412b3d66e74e (patch)
tree037a491a42b4b85e3e78d207cf4e6340e2f131f5
parentfd6ada706fe3d9fa91141bdd14e12529e93df42e (diff)
downloadtweetpipe-bd2cb3a953fa8226d6d3805482d9412b3d66e74e.tar.gz
Update readme
-rw-r--r--README.md23
1 files changed, 13 insertions, 10 deletions
diff --git a/README.md b/README.md
index 3f79275..8790efd 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,23 @@
-Encpipe
+Tweetpipe
=======
-The dum^H^H^Hsimplest encryption tool in the world.
+A fork of the dum^H^H^Hsimplest encryption tool in the world,
+[encpipe](https://github.com/jedisct1/encpipe), but with the crypto replaced by
+tweetnacl. Password hashing is implemented by a custom tweet-like version of
+pbkdf2hmacsha512.
# Usage
Encrypt a file using a password:
```sh
-encpipe -e -p password -i inputfile -o outputfile
+tweetpipe -e -p password -i inputfile -o outputfile
```
Decrypt a file using a password:
```sh
-encpipe -d -p password -i inputfile -o outputfile
+tweetpipe -d -p password -i inputfile -o outputfile
```
`-i` and `-o` can be set to `-` or omitted to read/write from the
@@ -28,20 +31,20 @@ If you don't feel inspired, `-G` prints a random password.
Example - encrypted file transfer:
```sh
-nc -l 6666 | encpipe -d -p password
-encpipe -e -p password -i /etc/passwd | nc 127.0.0.1 6666
+nc -l 6666 | tweetpipe -d -p password
+tweetpipe -e -p password -i /etc/passwd | nc 127.0.0.1 6666
```
Example - compressed, encrypted archives:
```sh
-zstd -5 -v -c "$FILE" | encpipe -e -p "$PASSWD" -o "${FILE}.zst.encpipe"
+zstd -5 -v -c "$FILE" | tweetpipe -e -p "$PASSWD" -o "${FILE}.zst.tweetpipe"
```
# Dependencies
-None. It includes [libhydrogen](https://libhydrogen.org) as a
-submodule. There is nothing to install.
+None. It includes [tweetnacl](https://tweetnacl.cr.yp.to/). There is nothing to
+install.
# Installation
@@ -52,4 +55,4 @@ sudo make install
# Why
-It was faster to write than remember how to use GnuPG and OpenSSL.
+Because I could.