From 3968b4ea233be198979fd3d837d3f9f05f480137 Mon Sep 17 00:00:00 2001 From: RussellBallestrini Date: Tue, 8 Jan 2013 22:19:20 -0500 Subject: [PATCH] Added some example output to README.rst --- README.rst | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 78be2cd..9ba2a8c 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,4 @@ -How to install +Installation =================== There are a number of ways to install this package:: @@ -10,6 +10,22 @@ There are a number of ways to install this package:: or specify *ago* under the *setup_requires* list within your *setuptools*-compatible project's *setup.py* file. +What are human readable timedeltas? +======================================== + +ago.py makes customizable human readable timedeltas, for example: + +Testing past:: + + Russell commented 1 year, 127 days, 16 hours ago + You replied 1 year, 127 days ago + +Testing future:: + + Program will shutdown in 2 days, 3 hours, 27 minutes + Job will run 2 days, 3 hours from now + + How to use ==================