rephrase README section about the "download password" feature
[coquelicot.git] / README
diff --git a/README b/README
index 9eaffc1..6ebb748 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
 About “Coquelicot”
 ==================
 
-Coquelicot is a "one-click" file sharing web application with a specific
+[Coquelicot] is a "one-click" file sharing web application with a specific
 focus on protecting users' privacy.
 
 Basic principle: users can upload a file to the server, in return they
@@ -12,6 +12,8 @@ Coquelicot aims to protect, to some extent, users and system
 administrators from disclosure of the files exchanged from passive and
 not so active attackers.
 
+[Coquelicot]: https://coquelicot.potager.org/
+
 Features
 --------
 
@@ -72,10 +74,10 @@ Features
 
  * Download can be protected by a password
 
-   When uploading, a password can be specified which will be used as
-   the encryption key. In order to download the file, the password
-   must be entered through in a POST'ed form, preventing the password
-   from appearing in the server logs.
+   When uploading, a password can be specified which will then be used
+   to encrypt the file. For subsequent downloads, the password
+   must be entered through in a POST'ed form. This prevents the password
+   from appearing in most server logs.
 
  * Files are stored with a random name
 
@@ -323,9 +325,12 @@ Future
    stored file size. Original file size will also be recorded in server
    logs. Padding could be used to improve this situation.
 
- * Make a Gem
+ * Make a usable Gem
 
-   Most Ruby stuff is installed using Gem, so Coquelicot should be one.
+   Most Ruby stuff is installed using Gem, so Coquelicot should also be
+   installable that way. What is mostly missing is an easy way to create
+   a default configuration and directories to hold uploaded files and
+   temp. data.
 
  * Package for Debian
 
@@ -399,16 +404,16 @@ is used. It contains a line for each file in the form:
 Authors
 -------
 
-    Coquelicot © 2010-2012 potager.org <jardiniers@potager.org>
+    Coquelicot © 2010-2013 potager.org <jardiniers@potager.org>
                © 2011 mh / immerda.ch  <mh+coquelicot@immerda.ch>
 
 Coquelicot is distributed under the [GNU Affero General Public License]
 version 3 or (at your option) any later version.
 
 Background image (`public/images/background.jpg`) derived from:  
-[“coquelicot”] © 2008 Jean-Louis Zimmermann  
+[“coquelicot” picture] © 2008 Jean-Louis Zimmermann  
 Licensed under [Creative Commons Attributions 2.0 Generic]  
 
-[“coquelicot”]: https://secure.flickr.com/photos/jeanlouis_zimmermann/2478019744/
+[“coquelicot” picture]: https://secure.flickr.com/photos/jeanlouis_zimmermann/2478019744/
 [GNU Affero General Public License]: http://www.gnu.org/licenses/agpl.txt
 [Creative Commons Attributions 2.0 Generic]: https://creativecommons.org/licenses/by/2.0/deed