update readme

README.md

@@ -1,29 +1,65 @@
 # SAML.to VSCode Extension
 
-This is the SAML.to VSCode Extension
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/saml-to/vscode?label=version) ![GitHub issues](https://img.shields.io/github/issues/saml-to/vscode) ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/saml-to/vscode/Push%20to%20Main)
+
+- Website: https://saml.to
+- Forums: https://github.com/saml-to/vscode/discussions
+- Documentation: https://docs.saml.to
+
+## Introduction
+
+This is the VSCode Extension for [SAML.to](https://saml.to). It allows for AWS role assumption within VSCode.
 
 ## Features
 
-TODO
+- Assume AWS Roles in VSCode
+- Automatic Refreshes
+- Automatically update `~/.aws/config`and `~/.aws/credentials` with: `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN`
+- Works seamlessly with the [AWS Toolkit](https://marketplace.visualstudio.com/items?itemName=AmazonWebServices.aws-toolkit-vscode)
+
+## Installation
+
+Please make sure the following is installed:
+
+- VSCode 1.84+
+- `aws` avaliable on the `$PATH`
 
-## Requirements
+Then, install the VSCode Extension from the [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=saml-to.saml-to-vscode).
 
-TODO
+## Getting Started
+
+Once [the VSCode Extension is installed](#installation), run the following commands to login and assume roles:
+
+- Open the Command Palette (`Cmd/Ctrl` + `Shift` + `P`)
+- Choose `SAML.to: Assume AWS Role`
+
+If no logins or roles are available, an administrator for an AWS account should complete the [initial setup](#Initial-Setup).
+
+Add the `--help` flag to any command for available options.
 
 ## Extension Settings
 
-TODO
+- `github.token`: Provide a GitHub Token instead of using VSCode Authentication. This token requires the `user:email` scope. (Ignores the `GITHUB_TOKEN` environment variable and/or VSCode Authentication if set.)
+- `assumeAws.assumeRoleAtStartup`: Automatically attempt to assume a role at startup. If `assumeAws.role` or `assumeAws.rememberRole` is set, the role prompt will be skipped.
+- `assumeAws.autoRefresh`: Automatically refresh the credentials before they expire.
+- `assumeAws.region`: The AWS Default Region to set after assuming a role. (Overridden by the `AWS_DEFAULT_REGION` environment variable.)
+- `assumeAws.role`: Skip role selection input and assume this role. (Overridden by the `AWS_ROLE_ARN` environment variable.)
+- `assumeAws.rememberRole`: Skip role selection input and assume the last role used. This is ignored when the `assumeAws.role` setting is set.
+- `assumeAws.profile.name`: Save AWS Credentials to a named profile in `~/.aws/config`. (Overridden by the `AWS_PROFILE` environment variable.)
+
+## Initial Setup
 
-## Known Issues
+Visit [SAML.to Install](https://saml.to/install) to get started by connecting a GitHub User or Organization to an AWS Account.
 
-TODO
+## Reporting Issues
 
-## Release Notes
+Please [Open a New Issue](https://github.com/saml-to/vscode/issues/new/choose) in GitHub if an issue is found with this tool.
 
-### 0.1
+## Maintainers
 
-Initial Release
+- [Scaffoldly](https://github.com/scaffoldly)
+- [cnuss](https://github.com/cnuss)
 
 ## License
 
-TODO
+[Apache-2.0 License](LICENSE)

package.json

@@ -7,6 +7,7 @@
   "license": "Apache-2.0",
   "private": false,
   "description": "VSCode Extension for SAML.to",
+  "icon": "resources/marketplace/[email protected]",
   "repository": "[email protected]:saml-to/vscode-extension.git",
   "bugs": {
     "url": "https://github.com/saml-to/vscode-extension/issues"
@@ -44,7 +45,7 @@
         "saml-to.assumeAws.assumeRoleAtStartup": {
           "type": "boolean",
           "default": true,
-          "markdownDescription": "Automatically attempt to assume a role at startup. If `assumeAws.role` or `assumeAws.rememberRole` is set, the role prompt will be skipped.`"
+          "markdownDescription": "Automatically attempt to assume a role at startup. If `assumeAws.role` or `assumeAws.rememberRole` is set, the role prompt will be skipped."
         },
         "saml-to.assumeAws.autoRefresh": {
           "type": "boolean",