Putting back the fun into unix

[user/henk/code/shell/rif.git] / README.md

diff --git a/README.md b/README.md
index 7b1f35944df4e4d76181d236dc6b3640714ca85c..69782f1ee06247fc5fa9f8c38f9fade9b7540106 100644 (file)
--- a/README.md
+++ b/README.md
@@ -31,6 +31,7 @@ To become a real IPv6 friend, you need to do the following things:
 - For each of your friends, check whether they are online
 - Import the friends of your friends and check whether they are
   online, too!
+- Send friend requests (like other platforms!)
 
 ### Example: Generating a key with the right comment
 
@@ -196,6 +197,21 @@ automates this process.
 You can probably just use your mail program for that - and you might
 even be able to send it IPv6 only!
 
+### Example: Invite a friend
+
+Live is not great without friends! Let's invite a friend! This is as
+easy is this:
+
+```
+printf 'Hello yournamehere!\n I am looking for real IPv6 friends.\n You find my friends on https://nico.ungleich.cloud/rifkeys.\nHow real IPv6 friends find each other is explained on https://code.ungleich.ch/nico/rif.\n Looking forward to befriend you!' | mail -s "friend request" ipv6@your.friend.example.com
+```
+
+And obviously this is waaaaaaaaay to long to type. That's why
+`rif-invitefriends.sh` puts this nicely into a script.
+
+Attention: this requires a working mail setup on your computer
+(i.e. outgoing emails sending by `mail` works).
+
 ## Finding friends
 
 As real IPv6 friends are decentralised, there is no central registry