Putting back the fun into unix

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

diff --git a/README.md b/README.md
index 38e9b904eccb18fec7ed19c9d11207a1222d337d..69782f1ee06247fc5fa9f8c38f9fade9b7540106 100644 (file)
--- a/README.md
+++ b/README.md
@@ -22,8 +22,8 @@ just connect to their computer!
 It's a bit geeky, but it works actually rather simple.
 To become a real IPv6 friend, you need to do the following things:
 
-- Generate a GPG key with a comment named RIF following the URL of
-  your computer
+- Generate a GPG key with a comment named **RIF** following the URL of
+  your computer (f.i. **RIF https://nico.ungleich.cloud**)
 - Ensure that the URL points to the IPv6 address of your computer
 - Setup a webserver on your computer
 - Export your key and all real IPv6 friend keys to your webserver as
@@ -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
 
@@ -159,6 +160,7 @@ curl -6 -s https://nico.ungleich.cloud/rifkeys | gpg --import
 
 You can also use the included rif-importfriends.sh.
 
+
 ### Example: Updating your friends
 
 Now that you have imported the friends of your friends, they have
@@ -178,17 +180,52 @@ gpg -a --export RIF > /var/www/html/rifkeys
 
 Or use the included `rif-exportfriends.sh`
 
+### Example: Importing friends of all friends and exporting them
+
+From time to time you might want to checkup on which friends gained
+new friends and add them to your friend list. This is as easy as
+iterating over all your friends and importing their friends into your
+friends list. And because you are a good friend, you might want to
+export all friends again.
+
+To make things easy, the included a script `rif-friendimportexport.sh`
+automates this process.
+
+
 ### Example: Sending a message to a friend
 
-Simply use your mail program for that.
-And obviously enable signing & encrypting the email.
+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
+of friends. Just startup the webserver on your machine, export your
+key(s) and ping your friend.
 
+With every friend that is added to your network, the reach grows in
+the chain of all friends of every friend!
 
-## To be added
+So just start in your small cycle and forward your friend URL to your
+friends!
 
-- advanced usage -> ipv6 email
 
-### CLI ideas
+## About
 
-- **rif prepare**: check webserver, keyring, etc.
-- **rif online**: check who is online
+Real IPv6 friend is a project launched by Nico Schottelius on 2019-09-10.
+If you want to become my friend, my friend URL is https://nico.ungleich.cloud.