Reindent; add info function and short code

[ambdownload.git] / README

diff --git a/README b/README
index f1f67b3..e9a53a7 100644 (file)
--- a/README
+++ b/README
@@ -95,4 +95,17 @@ Usually this will do
 
 You will need to do your own log rotation.
 
+You can include information about each download by using a shortcode:
+
+[ambdownloadinfo url='URL' file='FILENAME' dp='DECIMALPLACES']FORMAT[/ambdownloadinfo]
+
+FORMAT is like printf, but
+  $NAME represents the name of the file (per the target above)
+  $SIZE represents its size
+  $MD5SUM represents its md5sum (if expandedfile.md5sum exists)
+  $FSIZE represents the size written in a friendly manner
+
+Example usage (to be entered in the HTML editor)
+  The file is [ambdownloadinfo url='http://www.example.com/download' file='default']named <b>$NAME</b> has an
+  md5sum of <tt>$MD5SUM</tt> and is roughly $FSIZE in size[/ambdownloadinfo]