From f7baa18e647666adee42f43baa3bc0479af476f0 Mon Sep 17 00:00:00 2001
From: Tim Savannah <kata198@gmail.com>
Date: Fri, 19 May 2017 20:49:42 -0400
Subject: [PATCH] Note set_timeout decorator in README

---
 README.md  | 10 ++++++++++
 README.rst | 15 +++++++++++++++
 2 files changed, 25 insertions(+)

diff --git a/README.md b/README.md
index b02e71b..2250d7f 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,16 @@ This is the function wherein you pass the timeout, the function you want to call
 			@return - The return value that #func# gives
 		'''
 
+**set\_timeout**
+
+This is a decorator you can use on functions to apply func\_timeout. Takes a single argument -- timeout.
+
+Example:
+
+	@set_timeout(2.5)
+	def myFunction(self, arg1, arg2):
+		...
+
 **FunctionTimedOut**
 
 Exception raised if the function times out
diff --git a/README.rst b/README.rst
index 0acfe63..aa2fec8 100644
--- a/README.rst
+++ b/README.rst
@@ -36,6 +36,21 @@ This is the function wherein you pass the timeout, the function you want to call
 
 		'''
 
+
+**set_timeout**
+
+This is a decorator you can use on functions to apply func_timeout. Takes a single argument -- timeout.
+
+Example:
+
+	@set_timeout(2.5)
+
+	def myFunction(self, arg1, arg2):
+
+		...
+
+
+
 **FunctionTimedOut**
 
 Exception raised if the function times out