From 60d931b0b9bcbd7d1b4b6505da5146a06f9ae715 Mon Sep 17 00:00:00 2001 From: Florian Schlachter Date: Mon, 28 Jul 2014 16:38:27 +0200 Subject: [PATCH] README fix --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d462bfe..177cb21 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,12 @@ [![Build Status](https://travis-ci.org/flosch/pongo2-addons.svg?branch=master)](https://travis-ci.org/flosch/pongo2-addons) [![GitTip](http://img.shields.io/badge/gittip-support%20pongo-brightgreen.svg)](https://www.gittip.com/flosch/) -Official filter and tag add-ons for [pongo2](https://github.com/flosch/pongo2). Uses 3rd-party-libraries. +Official filter and tag add-ons for [pongo2](https://github.com/flosch/pongo2). Since this package uses +3rd-party-libraries, it's in its own package. -## How to use and install +## How to install and use -Install via `go get -u github.com/flosch/pongo2-addons`. +Install via `go get -u github.com/flosch/pongo2-addons`. All dependencies will be automatically fetched and installed. Simply add the following import line **after** importing pongo2: @@ -15,20 +16,26 @@ Simply add the following import line **after** importing pongo2: All additional filters/tags will be registered automatically. -## Filters +## Addons + +### Filters - Regulars - - **[slugify](https://docs.djangoproject.com/en/dev/ref/templates/builtins/#slugify)** (creates a slug for a given input) - **[filesizeformat](https://docs.djangoproject.com/en/dev/ref/templates/builtins/#filesizeformat)** (human-readable filesize; takes bytes as input) + - **[slugify](https://docs.djangoproject.com/en/dev/ref/templates/builtins/#slugify)** (creates a slug for a given input) - Markup - **markdown** (parses markdown text and outputs HTML; **hint**: use the **safe**-filter to make the output not being escaped) - Humanize - - **[timesince](https://docs.djangoproject.com/en/dev/ref/templates/builtins/#timesince)/[timeuntil](https://docs.djangoproject.com/en/1.6/ref/templates/builtins/#timeuntil)/[naturaltime](https://docs.djangoproject.com/en/dev/ref/contrib/humanize/#naturaltime)** (human-readable time [duration] indicator) - **[intcomma](https://docs.djangoproject.com/en/dev/ref/contrib/humanize/#intcomma)** (put decimal marks into the number) - **[ordinal](https://docs.djangoproject.com/en/dev/ref/contrib/humanize/#ordinal)** (convert integer to its ordinal as string) + - **[timesince](https://docs.djangoproject.com/en/dev/ref/templates/builtins/#timesince)/[timeuntil](https://docs.djangoproject.com/en/1.6/ref/templates/builtins/#timeuntil)/[naturaltime](https://docs.djangoproject.com/en/dev/ref/contrib/humanize/#naturaltime)** (human-readable time [duration] indicator) -## Tags +### Tags (nothing yet) + +## TODO + + - Support i18n/i10n \ No newline at end of file