1 files changed, 27 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..86738b3
--- /dev/null
+++ b/README
@@ -0,0 +1,27 @@
+
+  { pluginbase }
+
+    PluginBase is a module for Python that enables the
+    development of flexible plugin systems in Python.
+
+    Step 1:
+
+      from pluginbase import PluginBase
+      plugin_base = PluginBase(package='yourapplication.plugins')
+    
+    Step 2:
+    
+      plugin_source = plugin_base.make_plugin_source(
+          searchpath=['./path/to/plugins', './path/to/more/plugins'])
+    
+    Step 3:
+    
+      with plugin_source:
+          from yourapplication.plugins import my_plugin
+      my_plugin.do_something_cool()
+    
+    Or alternatively:
+
+      my_plugin = plugin_source.load_plugin('my_plugin')
+      my_plugin.do_something_cool()
+