jiaaro  committed 5b08214

improved formatting of the readme (imho)

  • Participants
  • Parent commits 9fdad27
  • Branches default

Comments (0)

Files changed (1)

-How to install:
+== How to install ==
 	1. Put the "badges" directory somewhere in your python path
 	2. Add "badges" to your installed apps (in the file)
 	3. Define the badges you wish to have on your site in the "" file of the badges app
 			(r'^badges/', include('badges.urls')),
-How to make badges:
+== How to make badges ==
 	I would encourage you to create a "" file and import it at the bottom of your file.
 	return "True," the badge will be awarded (unless it's a one-time-only and the user already has it)
+== Signals ==
 	When a badge is awarded, a signal is fired (found in badges.signals). The "sender" keyword argument 
 	is the metaBadge you defined (Autobiographer in this case), and NOT the badge model instance that 
 		badge_awarded.connect(do_something_after_badge_is_awarded, sender=Autobiographer)
-Manually Awarding a Badge:
+== Manually Awarding a Badge ==
 	You can manually award a badge to a user using the "award_to" method on the Badge model instance.