Merge pull request #282 from 2009/patch-1

[etc/awesome.git] / README.rst

diff --git a/README.rst b/README.rst
index f6938bde0e3234853ed9e49edf48ad457e1f588b..ec0abfdc6b4bf861390d2f92ad36f9784008c6a4 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -10,12 +10,15 @@ Layouts, widgets and utilities for Awesome WM 4.x
 :License: GNU-GPL2_
 :Source: https://github.com/copycat-killer/lain
 
+Warning
+-------
+
+If you still have to use branch 3.5.x, you can refer to the commit 301faf5_, but be aware that it's no longer supported.
+
 Description
 -----------
 
-**Note:** the update to 4.x is still in progress: if you experience issues, please report them in order to speed up the process.
-
-Successor of awesome-vain_, this module provides new layouts, a set of widgets and utility functions, in order to improve Awesome_ usability and configurability.
+Successor of awesome-vain_, this module provides new layouts, **asynchronous** widgets and utility functions, with the aim of improving Awesome_ usability and configurability.
 
 Read the wiki_ for all the info.
 
@@ -28,7 +31,7 @@ Just make sure that:
 
 - Your code fits with the general style of the module. In particular, you should use the same indentation pattern that the code uses, and also avoid adding space at the ends of lines.
 
-- Your code its easy to understand, maintainable, and modularized. You should also avoid code duplication wherever possible by adding functions or using ``lain.helpers``. If something is unclear, and you can't write it in such a way that it will be clear, explain it with a comment.
+- Your code its easy to understand, maintainable, and modularized. You should also avoid code duplication wherever possible by adding functions or using lain.helpers_. If something is unclear, and you can't write it in such a way that it will be clear, explain it with a comment.
 
 - You test your changes before submitting to make sure that not only your code works, but did not break other parts of the module too!
 
@@ -44,6 +47,8 @@ Screenshots
 .. image:: http://i.imgur.com/STCPcaJ.png
 
 .. _GNU-GPL2: http://www.gnu.org/licenses/gpl-2.0.html
+.. _301faf5: https://github.com/copycat-killer/lain/tree/301faf5370d045e94c9c344acb0fdac84a2f25a6
 .. _awesome-vain: https://github.com/vain/awesome-vain
 .. _Awesome: https://github.com/awesomeWM/awesome
 .. _wiki: https://github.com/copycat-killer/lain/wiki
+.. _lain.helpers: https://github.com/copycat-killer/lain/blob/master/helpers.lua