Updated README.md

To most recent version of documentation

Author: Zeqi Cui

README.md

@@ -1,11 +1,8 @@
-# Azure SQL Database Spark Connector
+# Spark connector for Azure SQL Databases and SQL Server
 
-The official connector for Spark and Azure SQL Database.
-
-This project provides a client library that allows your Azure SQL Database to be an input source or output sink for SparkJobs
-
-## Requirements
+The Spark connector for [Azure SQL Database](https://azure.microsoft.com/en-us/services/sql-database/) and [SQL Server](https://www.microsoft.com/en-us/sql-server/default.aspx) enables SQL databases, including Azure SQL Databases and SQL Server, to act as input data source or output data sink for Spark jobs. It allows you to utilize real time transactional data in big data analytics and persist results for adhoc queries or reporting. 
 
+Comparing to the built-in Spark connector, this connector provides the ability to bulk insert data into SQL databases. It can outperform row by row insertion with 10x to 20x faster performance. The Spark connector for Azure SQL Databases and SQL Server also supports AAD authentication. It allows you securely connecting to your Azure SQL databases from Azure Databricks using your AAD account. It provides similar interfaces with the built-in JDBC connector. It is easy to migrate your existing Spark jobs to use this new connector.
 
 ## How to connect to Spark using this library
 This connector uses Microsoft SQLServer JDBC driver to fetch data from/to the Azure SQL Database. 
@@ -16,7 +13,8 @@ All connection properties in
   Microsoft JDBC Driver for SQL Server
 </a> are supported in this connector. Add connection properties as fields in the `com.microsoft.azure.sqldb.spark.config.Config` object.
 
-### Reading from Azure SQL Database using Scala
+  
+### Reading from Azure SQL Database or SQL Server
 ```scala 
 import com.microsoft.azure.sqldb.spark.config.Config
 import com.microsoft.azure.sqldb.spark.connect._
@@ -31,12 +29,12 @@ val config = Config(Map(
   "queryTimeout"   -> "5"  //seconds
 ))
 
-val collection = sqlContext.read.azureSQL(config)
+val collection = sqlContext.read.sqlDB(config)
 collection.show()
 
 ```
 
-### Writing to Azure SQL Database using Scala
+### Writing to Azure SQL Database or SQL Server
 ```scala 
 import com.microsoft.azure.sqldb.spark.config.Config
 import com.microsoft.azure.sqldb.spark.connect._
@@ -52,10 +50,10 @@ val config = Config(Map(
 ))
 
 import org.apache.spark.sql.SaveMode
-collection.write.mode(SaveMode.Append).azureSQL(config)
+collection.write.mode(SaveMode.Append).sqlDB(config)
 
 ```
-### Pushdown query to Azure SQL Database using Scala
+### Pushdown query to Azure SQL Database or SQL Server
 For SELECT queries with expected return results, please use 
 [Reading from Azure SQL Database using Scala](#reading-from-azure-sql-database-using-scala)
 ```scala
@@ -77,7 +75,7 @@ val config = Config(Map(
 
 sqlContext.azurePushdownQuery(config)
 ```
-### Bulk Copy to Azure SQL Database / SQL Server using Scala
+### Bulk Copy to Azure SQL Database or SQL Server
 ```scala
 import com.microsoft.azure.sqldb.spark.bulkcopy.BulkCopyMetadata
 import com.microsoft.azure.sqldb.spark.config.Config
@@ -98,7 +96,7 @@ val bulkCopyConfig = Config(Map(
   "databaseName"      -> "MyDatabase",
   "user"              -> "username",
   "password"          -> "*********",
-  "databaseName"      -> "zeqisql",
+  "databaseName"      -> "MyDatabase",
   "dbTable"           -> "dbo.Clients",
   "bulkCopyBatchSize" -> "2500",
   "bulkCopyTableLock" -> "true",
@@ -108,26 +106,41 @@ val bulkCopyConfig = Config(Map(
 df.bulkCopyToSqlDB(bulkCopyConfig, bulkCopyMetadata)
 //df.bulkCopyToSqlDB(bulkCopyConfig) if no metadata is specified.
 ```
-## Active Directory / AccessToken authentication
-Simply specify your config authentication to connect using ActiveDirectory. 
-If not specified, default authentication method is server authentication.
 
-```scala
-val config = Config(Map(
-  "url"                    -> "mysqlserver.database.windows.net",
-  "databaseName"           -> "MyDatabase",
-  "user"                   -> "[email protected]",
-  "password"               -> "*********",
-  "authentication"         -> "ActiveDirectoryPassword",
-  "trustServerCertificate" -> "true",
-  "encrypt"                -> "true"
-))
-
-```
+## Requirements
+Official supported versions
 
+| Component | Versions Supported |
+| --------- | ------------------ |
+| Apache Spark | 2.0.2 or later |
+| Scala | 2.10 or later |
+| Microsoft JDBC Driver for SQL Server | 6.2 or later |
+| Microsoft SQL Server | SQL Server 2008 or later |
+| Azure SQL Databases | Supported |
 
 ## Download
-
 ### Download from Maven
+*TBD*
 
 ### Build this project
+Currently, the connector project uses maven. To build the connector without dependencies, you can run:
+```sh
+mvn clean package
+```
+
+## Contributing & Feedback
+
+This project has adopted the [Microsoft Open Source Code of
+Conduct](https://opensource.microsoft.com/codeofconduct/).  For more information
+see the [Code of Conduct
+FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact
+[[email protected]](mailto:[email protected]) with any additional
+questions or comments.
+
+To give feedback and/or report an issue, open a [GitHub
+Issue](https://help.github.com/articles/creating-an-issue/).
+
+
+*Apache®, Apache Spark, and Spark® are either registered trademarks or
+trademarks of the Apache Software Foundation in the United States and/or other
+countries.*