From 18b051765934c2b1411ca0ccc12b8126e9fd085e Mon Sep 17 00:00:00 2001
From: Sam Stephenson <sam@37signals.com>
Date: Thu, 29 Dec 2011 18:02:36 -0600
Subject: [PATCH] Document special variables

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/README.md b/README.md
index fecda1e..5ada479 100644
--- a/README.md
+++ b/README.md
@@ -99,3 +99,23 @@ load test_helper
 will source the script `test/test_helper.bash` in your test file. This
 can be useful for sharing functions to set up your environment or load
 fixtures.
+
+### Special variables
+
+There are several global variables you can use to introspect on Bats
+tests:
+
+* `$BATS_TEST_FILENAME` is the fully expanded path to the Bats test
+file.
+* `$BATS_TEST_DIRNAME` is the directory in which the Bats test file is
+located.
+* `$BATS_TEST_NAMES` is an array of function names for each test case.
+* `$BATS_TEST_NAME` is the name of the function containing the current
+test case.
+* `$BATS_TEST_DESCRIPTION` is the description of the current test
+case.
+* `$BATS_TEST_NUMBER` is the (1-based) index of the current test case
+in the test file.
+* `$BATS_TMPDIR` is the location to a directory that may be used to
+store temporary files.
+