readme examples

1 files changed, 23 insertions, 1 deletions

diff --git a/README.md b/README.md
index c7d03ef..7c3b90b 100644
--- a/README.md
+++ b/README.md
@@ -75,7 +75,29 @@ On Linux:
     '/home/trentm/.superapp/caches'
 
 
-# typical usage
+# `AppDirs` for convenience
 
+    >>> from appdirs import AppDirs
+    >>> dirs = AppDirs("SuperApp", "Acme")
+    >>> dirs.user_data_dir
+    '/Users/trentm/Library/Application Support/SuperApp'
+    >>> dirs.site_data_dir
+    '/Library/Application Support/SuperApp'
+    >>> dirs.user_cache_dir
+    '/Users/trentm/Library/Caches/SuperApp'
+
+Note that the `AppDirs` default on Windows is to append "Caches" to the
+`.user_cache_dir` as suggested above.
+
+    
+# Per-major-version isolation
 
+    >>> from appdirs import AppDirs
+    >>> dirs = AppDirs("SuperApp", "Acme", version="1.0")
+    >>> dirs.user_data_dir
+    '/Users/trentm/Library/Application Support/SuperApp/1.0'
+    >>> dirs.site_data_dir
+    '/Library/Application Support/SuperApp/1.0'
+    >>> dirs.user_cache_dir
+    '/Users/trentm/Library/Caches/SuperApp/1.0'