Update README

Author: Calvin Allen

README.md

@@ -1,105 +1,39 @@
-<p align="center">
-  <a href="https://github.com/actions/typescript-action/actions"><img alt="typescript-action status" src="https://github.com/actions/typescript-action/workflows/build-test/badge.svg"></a>
-</p>
+# calvinallen/action-vs-marketplace-publish
 
-# Create a JavaScript Action using TypeScript
+Github Action to publish your Visual Studio extension to the marketplace
 
-Use this template to bootstrap the creation of a TypeScript action.:rocket:
+## Usage
 
-This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance.  
+You can use the VS Marketplace Publish GitHub Action by configuring a YAML-based workflow file, e.g. .github/workflows/deploy.yml.
 
-If you are new, there's also a simpler introduction.  See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
+> *This action only works on a Windows-based runner*
 
-## Create an action from this template
+## Publish a local VSIX File
 
-Click the `Use this Template` and provide the new repo details for your action
+```yml
+steps:
+    - name: Checkout
+      uses: actions/checkout@v2
 
-## Code in Main
+    - name: Visual Studio Marketplace Publisher
+      uses: CalvinAllen/action-vs-marketplace-publish@v1
+      with:
+        # REQUIRED
+        marketplace-pat: ${{ secrets.vs_pat }}
+        publish-manifest-path: ./src/vsixManifest.json
+        vsix-path: ./src/outputFolder/Extension.vsix
 
-> First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance.
-
-Install the dependencies  
-```bash
-$ npm install
-```
-
-Build the typescript and package it for distribution
-```bash
-$ npm run build && npm run package
-```
-
-Run the tests :heavy_check_mark:  
-```bash
-$ npm test
-
- PASS  ./index.test.js
-  ✓ throws invalid number (3ms)
-  ✓ wait 500 ms (504ms)
-  ✓ test runs (95ms)
-
-...
-```
-
-## Change action.yml
-
-The action.yml defines the inputs and output for your action.
-
-Update the action.yml with your name, description, inputs and outputs for your action.
-
-See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
-
-## Change the Code
-
-Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
-
-```javascript
-import * as core from '@actions/core';
-...
-
-async function run() {
-  try { 
-      ...
-  } 
-  catch (error) {
-    core.setFailed(error.message);
-  }
-}
-
-run()
-```
-
-See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
-
-## Publish to a distribution branch
-
-Actions are run from GitHub repos so we will checkin the packed dist folder. 
-
-Then run [ncc](https://github.com/zeit/ncc) and push the results:
-```bash
-$ npm run package
-$ git add dist
-$ git commit -a -m "prod dependencies"
-$ git push origin releases/v1
+        # OPTIONAL
+        vs-version: latest
+        vs-prerelease: false
 ```
 
-Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project.
-
-Your action is now published! :rocket: 
-
-See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
-
-## Validate
-
-You can now validate the action by referencing `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml))
-
-```yaml
-uses: ./
-with:
-  milliseconds: 1000
-```
-
-See the [actions tab](https://github.com/actions/typescript-action/actions) for runs of this action! :rocket:
-
-## Usage:
+## Inputs
 
-After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and latest V1 action
+| Input                 | Required | Description                                                                                                          |
+| --------------------- | -------- | -------------------------------------------------------------------------------------------------------------------- |
+| marketplace-pat       | Y        | Your 'Personal Access Token' to perform actions on the Visual Studio Marketplace                                     |
+| publish-manifest-path | Y        | Path to the manifest used for the publish                                                                            |
+| vsix-path             | Y        | Path to the local VSIX package you wish to publish                                                                   |
+| vs-version            | N        | Specify the exact version of Visual Studio tooling to use; default to `latest`                                       |
+| vs-prerelease         | N        | Allow a pre-release installation of Visual Studio tooling; default to `false`                                        |