From 970702031b7db3731b4ebada5444837fd1a49a39 Mon Sep 17 00:00:00 2001 From: Teddy Wing Date: Mon, 21 Apr 2014 14:58:03 -0400 Subject: README: make some edits to existing sections For better clarity. --- README.rdoc | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.rdoc b/README.rdoc index 0c5b65f..19d80c8 100644 --- a/README.rdoc +++ b/README.rdoc @@ -3,9 +3,11 @@ A Django template tag that allows you to hide pre-release features but make them == Requirements -Requires Django 1.4 or higher. Currently not configured for Django 1.7, but I'll be updating the package to add support for it once released. +[Django] + Requires Django 1.4 or higher. Currently django-sneak-peek does not take advantage of the built-in migrations in Django 1.7, but I'll be updating the package to add support for them once 1.7 released. -{South}[https://pypi.python.org/pypi/South/0.8.4] is required for migrations. django-sneak-peek includes a data migration that adds a ContentType and Permission. The permission is used to determine whether or not a user can view sneak peek content. +[South] + {South}[https://pypi.python.org/pypi/South/0.8.4] is required for migrations. This package includes a data migration that adds a ContentType and an associated Permission. The permission is used to determine whether or not a user can view sneak peek content. == Installation @@ -31,7 +33,7 @@ Requires Django 1.4 or higher. Currently not configured for Django 1.7, but I'll == Usage -django-sneak-peek defines a template tag called sneak_peek. Markup that you want to conditionally hide gets wrapped in this template tag. +django-sneak-peek defines a template tag called sneak_peek. Markup that you want to conditionally hide must be wrapped in this template tag. Add the django-sneak-peek CSS file to all pages where you plan to use the template tag: @@ -48,8 +50,8 @@ Wrap secret markup in sneak_peek tags:

Secret pre-release feature

- This entire div is hidden from users who don't have the - sneak_peek permission. + This entire div will not appear in the HTML output unless the + current user has the sneak_peek permission.

{% endsneak_peek %} -- cgit v1.2.3