Merge remote branch 'nadir/translations/de'
[coquelicot.git] / README
diff --git a/README b/README
index 43ab9a0..8647479 100644 (file)
--- a/README
+++ b/README
@@ -8,7 +8,7 @@ Basic principle: users can upload a file to the server, in return they
 get a unique URL which can be shared with others in order to download
 the file.
 
-Coquelicot aims to protect, to some extend, users and system
+Coquelicot aims to protect, to some extent, users and system
 administrators from disclosure of the files exchanged from passive and
 not so active attackers.
 
@@ -104,11 +104,7 @@ On Debian, one can fulfill its dependencies by issuing:
 
     apt-get install libsinatra-ruby1.8 libopenssl-ruby1.8 \
                     libhaml-ruby1.8 liblockfile-ruby libgettext-ruby1.8 \
-                    rake
-
-Then create the translation catalog through:
-
-    rake makemo
+                    libjson-ruby1.8 rake
 
 Finally you need to figure out the best way to host a Rack application
 depending on your setup. *evil grin*
@@ -261,14 +257,20 @@ with the following responsabilities:
 
  * `public/javascripts/coquelicot.auth.<METHOD>.js:`
 
-    We expect 3 javascript methods in that file:
-
-    - `authenticationData()`: returns a hash of all the necessary data
-      to authenticate on the app side.
-    - `authenticationFocus()`: set the focus on the first authentication
-      form field.
-    - `authenticationReset()`: reset authentication fields after
-      a failed authentication.
+    This file should define 'authentication' as an object with the following
+    methods:
+
+    - `getData()`: returns an object of all the necessary data
+      to authenticate on the app side. Keys should have the same name
+      as the input fields used to authenticate without Javascript.
+    - `focus()`: set the focus on the first authentication form field.
+    - (optional) `handleSuccess()`: arbitrary action upon successful
+      authentication. This is called after the livebox is closed.
+    - (optional) `handleReject()`: arbitrary action when access
+      get rejected. One can reset authentication fields after a failed
+      authentication.
+    - (optional) `handleFailure()`: arbitrary action when there was
+      a problem in the authentication procedure.
 
  * `views/auth/<METHOD>.haml`:
 
@@ -280,8 +282,13 @@ with the following responsabilities:
 Authors
 -------
 
-Coquelicot © 2010-2012 potager.org <jardiniers@potager.org>
+Coquelicot © 2010-2012 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. See LICENSE for details.
+
+Background image (`public/images/background.jpg`) derived from:  
+"coquelicot" © 2008 Jean-Louis Zimmermann  
+Licensed under Creative Commons Attributions 2.0 Generic  
+<https://secure.flickr.com/photos/jeanlouis_zimmermann/2478019744/>