* documentation updates, print a warning if "import apt" is used

1 files changed, 15 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 00000000..2e337c8a
--- /dev/null
+++ b/README
@@ -0,0 +1,15 @@
+Python-apt is a wrapper to use features of apt from python.
+
+It contains the following modules:
+
+C++ Wrapper:
+------------
+apt_pkg - access to libapt-pkg (wrapper to the lowlevel c++ code)
+apt_inst - access to libapt-inst (wrapper to the lowlevel c++ code)
+
+Python module:
+--------------
+WARNING: the API of this module is not stable yet
+
+apt - high level python interface build on top of apt_pkg, apt_inst
+