* README.org: update docs

djcb · Feb 21, 2012 · 3fc1972 · 3fc1972
1 parent 2b34851
commit 3fc1972
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/README.org b/README.org
@@ -341,7 +341,8 @@
 
    - create "sauron-foo.el", and make sure it's in the load-path
    - sauron-foo should implement at least:
-     + ~sauron-foo-start~ to start the module
+     + ~sauron-foo-start~ to start the module; this function should return ~t~
+       if startup is successful, ~nil~ otherwise
      + ~sauron-foo-stop~ to stop the module / cleanup etc.
    - add sauron-foo.el with =(provide 'sauron-foo)=
    - now, add ~sauron-foo~ to your ~sauron-modules~