Index: appengine/findit/gae_libs/README.md |
diff --git a/appengine/findit/gae_libs/README.md b/appengine/findit/gae_libs/README.md |
new file mode 100644 |
index 0000000000000000000000000000000000000000..fd0a474ab4159002a828d080486c1cb63b06582b |
--- /dev/null |
+++ b/appengine/findit/gae_libs/README.md |
@@ -0,0 +1,16 @@ |
+# gae_libs |
+ |
+The [gae\_libs](gae_libs) module is for shared code that depends on App Engine |
+APIs (gae is short for Google App Engine), eg: an NDB model that supports |
+keeping multiple versions of the same information like configuration. |
+ |
+It also depends on the sibling [libs](libs) module, and provides gae wrappers |
+for the code there, e.g., a Gitiles client with data cached in memcache on App |
+Engine. |
+ |
+# How to use? |
+ |
+Create symbolic links to both [gae\_libs](gae_libs) and [libs](libs) in the same |
+directory PARENT\_DIR, and ensure that PARENT\_DIR is in sys.path or PYTHONPATH. |
+ |
+The usage would look like: `from gae_libs import API_MODULE_NAME` |