reorganize package inorder to emphasize freebase-api as the main one

git-svn-id: http://freebase-python.googlecode.com/svn/trunk@88 5914aa95-5b3a-0410-a3b5-7b719e7fe9b2

1 files changed, 42 insertions, 0 deletions

diff --git a/freebase-README b/freebase-README
new file mode 100644
index 0000000..fce8b5b
--- /dev/null
+++ b/freebase-README
@@ -0,0 +1,42 @@
+description='Python client library for Freebase API service',
+maintainer_email='developers@freebase.com',
+url='http://www.freebase.com/',
+
+INSTALL:
+ 
+	/usr/bin/python setup.py install
+
+    When using freebase-python with Google AppEngine you will also need to
+    include the files in appengine_stubs with you AppEngine app.
+
+SYNOPSIS:
+
+	#!/usr/bin/python 
+
+	from freebase.api import HTTPMetawebSession, MetawebError
+
+	mss = HTTPMetawebSession('www.freebase.com')
+
+	query = {    'type':'/music/artist',
+	             'name':'Sting',
+	             'album':[],
+	         }
+
+	result = mss.mqlread(query)
+
+	for album in result.album:
+	    print album
+TESTING:
+	
+	cd test
+	/usr/bin/python test_all.py -v
+
+	test_login (__main__.TestFreebase) ... ok
+	test_read (__main__.TestFreebase) ... ok
+	test_write (__main__.TestFreebase) ... ok
+	
+	----------------------------------------------------------------------
+	Ran 3 tests in 0.691s
+
+	OK
+