Update README.md

First draft of docs for version 0.3.0

Author: labkey-steveh

README.md

@@ -1,5 +1,18 @@
+[Credentials](#cred)
+
 # About
-Python client API for LabKey Server. To get started, please see the [full documentation for this library](https://www.labkey.org/wiki/home/Documentation/page.view?name=python).
+The Python client API for LabKey Server lets you query, insert and update data on a LabKey Server from a Python client.
+
+# Release Notes
+
+Changes in the current release:
+
+- Support for Python 3
+- Support for netrc files (.labkeycredentials.txt files are now deprecated)
+- server_context parameter on all methods
+- PEP standards - the latest update follows PEP code styling standards
+- New samples
+- New methods: load_batch and save_batch
 
 # Installation
 To install, simply use `pip`:
@@ -15,7 +28,7 @@ As of v0.4.0 this API no longer supports using a ``.labkeycredentials.txt`` file
 
 On a Mac, UNIX, or Linux system the netrc file should be named ``.netrc`` (dot netrc) and on Windows it should be named ``_netrc`` (underscore netrc). The file should be located in your home directory and the permissions on the file must be set so that you are the only user who can read it, i.e. it is unreadable to everyone else.
 
-To create the netrc on a Windows machine, first create an environment variable called ’HOME’ that is set to your home directory (c:/Users/<User-Name> on Vista or Windows 7) or any directory you want to use.
+To create the netrc on a Windows machine, first create an environment variable called ’HOME’ that is set to your home directory (for example, C:/Users/johndoe) or any directory you want to use.
 
 In that directory, create a text file with the prefix appropriate to your system, either an underscore or dot.
 
@@ -26,22 +39,54 @@ login <user-email>
 password <user-password>
 ```
 
-One example would be:
+For example:
 ```
 machine mymachine.labkey.org
 login user@labkey.org
 password mypassword
 ```
-Another example would be:
-```
-machine mymachine.labkey.org login user@labkey.org password mypassword
+Note that the netrc file only deals with connections at the machine level and should not include a port or protocol designation, meaning both "mymachine.labkey.org:8888" and "https://mymachine.labkey.org" are incorrect. 
+
+# Supported Functions
+
+- **labkey.query.select_rows()** - Query and get results sets from LabKey Server.
+- **labkey.query.execute_sql()** - Execute SQL (LabKey SQL dialect) through the query module on LabKey Server.
+- **labkey.query.insert_rows()** - Insert rows into a table on LabKey Server.
+- **labkey.query.update_rows()** - Update rows in a table on LabKey Server.
+- **labkey.query.delete_rows()** - Delete records in a table on LabKey Server.
+- **labkey.experiment.load_batch()** - Retreive assay data (batch level) from LabKey Server.
+- **labkey.experiment.save_batch()** - Save assay data (batch level) on LabKey Server. 
+
+# Examples
+
+Sample code is availabe in the [samples](https://github.com/LabKey/labkey-api-python/tree/experiment/samples) directory.
+
+The following gets data from the Users table on your local machine:
+
+```python
+from labkey.utils import create_server_context
+from labkey.query import select_rows
+
+print("Create a server context")
+labkey_server = 'localhost:8080'
+project_name = 'ModuleAssayTest'  # Project folder name
+contextPath = 'labkey'
+schema = 'core'
+table = 'Users'
+
+server_context = create_server_context(labkey_server, project_name, contextPath, use_ssl=False)
+
+result = select_rows(server_context, schema, table)
+if result is not None:
+    print(result['rows'][0])
+    print("select_rows: Number of rows returned: " + str(result['rowCount']))
+else:
+    print('select_rows: Failed to load results from ' + schema + '.' + table)
 ```
 
 # Supported Versions
 Python 2.6+ and 3.4+ are fully supported.
-
 LabKey Server v13.3 and later.
 
 # Contributing
 This library and the LabKey Server are maintained by the LabKey Software Foundation. If you have any questions or need support, please use the [LabKey Server support forum](https://www.labkey.org/wiki/home/page.view?name=support).
-