Browse Source

Improve Clean Summary plugin ReadME

Justin Mayer 8 years ago
parent
commit
dca3427da0
1 changed files with 15 additions and 15 deletions
  1. 15 15
      clean_summary/README.md

+ 15 - 15
clean_summary/README.md

@@ -1,34 +1,34 @@
-#Clean Summary Plugin#
+# Clean Summary Plugin
 
-Plugin to clean your summary of excess images. Images can take up much more
-space than text and lead to summaries being different sizes on archive and 
-index pages. With this plugin you can specify a maximum number of images that
+This plugin cleans your summary of excess images. Images can take up much more
+space than text and lead to summaries being different sizes on archive and
+index pages. With this plugin, you can specify a maximum number of images that
 will appear in your summaries.
 
 There is also an option to include a minimum of one image.
 
-##Settings##
+## Settings
 
-This plugin has two settings. `CLEAN_SUMMARY_MAXIMUM` which takes an int, and 
-`CLEAN_SUMMARY_MINIMUM_ONE` which takes a boolean. They default to 0 and False.
+This plugin has two settings: `CLEAN_SUMMARY_MAXIMUM`, which takes an integer,
+and `CLEAN_SUMMARY_MINIMUM_ONE`, which takes a Boolean value. They default to
+`0` and `False`, respectively.
 
-`CLEAN_SUMMARY_MAXIMUM` sets the maximum number of images that will appear in 
+`CLEAN_SUMMARY_MAXIMUM` sets the maximum number of images that will appear in
 your summary.
 
-if `CLEAN_SUMMARY_MINIMUM_ONE` is set to `True` and your summary doesn't already
-contain an image, the plugin will add the first image in your article (if one 
+If `CLEAN_SUMMARY_MINIMUM_ONE` is set to `True` and your summary doesn't already
+contain an image, the plugin will add the first image in your article (if one
 exists) to the beginning of the summary.
 
-##Requirements##
+## Requirements
 
 Requires Beautiful Soup:
 
     pip install BeautifulSoup4
 
+## Usage with Summary Plugin
 
-##Usage with Summary Plugin##
-
-If using the summary plugin, make sure summary appears in your plugins before
-clean summary. Eg.
+If using the Summary plugin, make sure it appears in your plugin list before
+the Clean Summary plugin. For example:
 
     PLUGINS = ['summary', 'clean_summary', ... ]