Permalink
Browse files

Making README a little better.

  • Loading branch information...
Julia Elman
Julia Elman committed May 17, 2012
1 parent 7b3d9a7 commit 40f2392bfedc402afdceb7e26104a51981999108
Showing with 10 additions and 11 deletions.
  1. +10 −11 README.md
View
@@ -1,21 +1,20 @@
-Anora - Django templatetag
-============================
+#Anora - Django templatetag
Anora is a simple_tag that determines whether or not a word should have an "a" or "an" in front of it. Adds either one of these depending on the phoentic value of the given text. It will also automatically add one space before the text and
-
-Install
-----------------------------
+##Install
1. Add ``anora`` to your ``INSTALLED_APPS``
2. Add ``{% load anora %}`` to the top of templates you wish to use these tags in.
+##Usage
+``{% load anora %}``
+
+``I was taking a walk in the woods today. I came across {{ animal_type|anora }}.``
-Usage
-----------------------------
-{% load anora %}
+####Possible outcomes from the above:
-I was taking a walk in the woods today. I came across {{ animal_type|anora }}.
+I was taking a walk in the woods today. I came across a raccoon.
+I was taking a walk in the woods today. I came across an owl.
-Credits
-----------------------------
+##Credits
Original template filter can he found [here](http://djangosnippets.org/snippets/1519/).

0 comments on commit 40f2392

Please sign in to comment.