📝 rewrite README.md for users and contributors

Author: raksit31667

README.md

@@ -1,36 +1,40 @@
-# azure-pipelines-task-template
+# Azure DevOps Databricks REST API
 
-![Azure Pipelines](./images/azure-pipelines.png)
+![Azure Databricks](./images/icon.png)
 
 ## Introduction
 
-This repository contains a quick start template for creating and publishning a custom azure pipelines task written in TypeScript. It uses [webpack](https://webpack.js.org) to bundle scripts and is configured to use [jest](https://jestjs.io/) to run tests.
+This repository contains an Azure DevOps extension for interacting with Azure Databricks via [REST API](https://docs.databricks.com/dev-tools/api/latest/index.html). It supports Databricks management on clusters, jobs, and instance pools.  
 
-## Getting started
-
-There are a few small steps that need to be carried out before you can start using this template for your purpose-
+You may find this extension **useful** when:
+- You are running Spark (structured) streaming jobs attached to automated clusters.
+- You are leveraging instance pools for [fast startup time](https://databricks.com/blog/2019/11/11/databricks-pools-speed-up-data-pipelines.html) and scalability.
 
-1. Create two guids and replace `{{guid_production}}` and `{{guid_development}}` occurences with these values in webpack [config](webpack.config.js). You can use [this](https://www.guidgenerator.com) tool to generate guids. *(It helps to have different guids for different environments as it allows you to install multiple extension flavors in the same account)*
+You may find this extension **useless** when:
+- You are running Spark jobs on an interactive clusters, or running on scheduled manner.
+- You are running jobs via Jupyter notebooks.
 
-1. Enter your publisher and author name in place of `{{publisher}}` and `{{author}}` strings. These files have references to these strings - [webpack config](webpack.config.js), [task.json](./src/custom-task/task.json) and [manifest.json](./src/manifest.json)
+## Getting started
 
-1. Create a personal access token for the Azure Devops account where you would test run your task. Refer [this](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops) to learn how to create a personal access token.
+- Install an extension via <https://marketplace.visualstudio.com/items?itemName=raksit31667.azure-devops-databricks-rest-api>.
+- Add Azure DevOps task similar as a code snippet below:
 
-1. Set following environment variables to enable inner loop commands-
-    - `BUILD_ENV` = **development**
-    - `ADO_PAT` - Your personal access token
-    - `ADO_ACCOUNT_URI` - The default collection URI for your account *(eg. <https://dev.azure.com/{{name}})>*
-    - `DEV_PUBLISHER` - Id of your publisher account
+```yaml
+- task: VerifyAllDatabricksJobRunning@1
+displayName: Verify Databricks jobs
+inputs:
+    jobs: '<your-job-name-here>'
+    region: 'your-region-here>'
+    accessToken: '<your-databricks-access-token>'
+```
 
-1. Run following commands to verify setup-
-    1. `npm install` (Installs npm dependencies)
-    1. `npm run dev` (Builds, packages and publishes the extension)
+Note that every task requires **region** and **access token**. You can find a region from your 
+Databricks workspace URL (e.g. <https://southcentralus.azuredatabricks.net/?o=0000000>). For access token, you can generate via **User Settings**, see an instruction <https://docs.databricks.com/dev-tools/api/latest/authentication.html>.
 
-1. Refer to [package.json](./package.json) to see the list of all commands.
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 
-## Typical inner loop commands
+Please make sure to update tests as appropriate.
 
-| What changed? | Which NPM command to run? | What it does? |
-| ------------- |:-------------:|:----- |
-| Task implementation | `npm run dev:task` | Build, package and update policy task without updating extension |
-| Anything else | `npm run dev` | Build, package and publish full extension |
+## License
+[MIT](https://choosealicense.com/licenses/mit/)