Addition of block token to ensure json block rendering is only available to those...

[project/context.git] / README.txt

diff --git a/README.txt b/README.txt
index 5a5619b..3d8cb15 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -1,41 +1,27 @@
-$Id$
 
-Context 3.0 for Drupal 6.x
+Context 3.x for Drupal 6.x
+--------------------------
+Context allows you to manage contextual conditions and reactions for
+different portions of your site. You can think of each context as
+representing a "section" of your site. For each context, you can choose
+the conditions that trigger this context to be active and choose different
+aspects of Drupal that should react to this active context.
+
+Think of conditions as a set of rules that are checked during page load
+to see what context is active. Any reactions that are associated with
+active contexts are then fired.
 
 
 Installation
 ------------
 Context can be installed like any other Drupal module -- place it in
 the modules directory for your site and enable it (and its requirement,
-context) on the admin/build/modules page.
+CTools) on the `admin/build/modules` page.
 
 You will probably also want to install Context UI which provides a way for
 you to edit contexts through the Drupal admin interface.
 
 
-Upgrade from Context 2.0 for Drupal 6.x
----------------------------------------
-
-- Download latest Context 3.0 and latest CTools release and place in modules
-  directory.
-- Run update.php.
-- If your site contains contexts defined in code they will be overridden.
-  Re-export them to code again.
-
-
-Basic usage
------------
-Context allows you to manage contextual conditions and reactions for
-different portions of your site. You can think of each context as
-representing a "section" of your site. For each context, you can choose
-the conditions that trigger this context to be active and choose different
-aspects of Drupal that should respond to this active context.
-
-Think of conditions as a set of rules that are checked during page load
-to see what context is active. Any reactions that are associated with
-active contexts are then fired.
-
-
 Example
 -------
 You want to create a "pressroom" section of your site. You have a press
@@ -51,11 +37,27 @@ pressroom section.
 4. Under "Reactions > Blocks", add the contact block to a region.
 5. Save the context.
 
+For a more in-depth overview of the UI components, see the Context UI
+`README.txt`.
+
+
+Upgrading from Context 2.x for Drupal 6.x
+-----------------------------------------
+- Download latest Context 3.x and latest CTools release and place in modules
+  directory. Make sure to *remove* the existing Context 2.x directory before
+  unpacking Context 3.x. There are stale files in the 2.x branch that need to
+  be removed.
+- Run `update.php` or `drush updatedb`.
+- If your site contains contexts defined in code they will be overridden.
+  Re-export them to code again. If you are using any custom conditions or
+  reactions, you may need to upgrade or reconfigure them by hand. See `API.txt`
+  for instructions on adding and extending plugins in Context.
+
 
 Hooks
 -----
-
-See context.api.php for the hooks made available by context.
+See `context.api.php` for the hooks made available by context and `API.txt` for
+usage examples.
 
 
 Maintainers
@@ -63,6 +65,7 @@ Maintainers
 
 - yhahn (Young Hahn)
 - jmiccolis (Jeff Miccolis)
+- Steven Jones
 
 
 Contributors