Skip to content

Commit 50ab76a

Browse files
authored
Improve marketplace presentation and docs (#2)
1 parent f976896 commit 50ab76a

File tree

8 files changed

+28
-13
lines changed

8 files changed

+28
-13
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
**Documents all notable changes to the LocalStack VSCode Extension.**
44

5+
## 0.1.1 (2023-07-13)
6+
7+
- Update readme with marketplace link
8+
- Add animated gifs for features
9+
510
## 0.1.0 (2023-07-13)
611

712
Initial preview release.

DEVELOPMENT.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,14 @@
2121

2222
## Publish
2323

24-
<!-- TODO: Describe publish steps after first successful publishing -->
24+
1. Bump version in `package.json` and run `npm install` to update `package-lock.json` as well
25+
2. Add changelog to `CHANGELOG.md`
26+
3. Package using `vsce package`
27+
4. Publish using `vsce publish`
2528

26-
Follow the instructions for [Publishing Extensions](https://code.visualstudio.com/api/working-with-extensions/publishing-extension).
29+
For more details, refer to [Publishing Extensions](https://code.visualstudio.com/api/working-with-extensions/publishing-extension).
30+
31+
<!-- TODO: automate using GitHub Action CI build https://code.visualstudio.com/api/working-with-extensions/continuous-integration -->
2732

2833
## Known Issues
2934

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ package:
1010
vsce package
1111

1212
publish:
13-
vsce package
13+
vsce publish
1414

1515
.PHONY: install watch package publish

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
# LocalStack VSCode Extension (Preview)
22

3+
![Marketplace Version](https://img.shields.io/vscode-marketplace/v/LocalStack.localstack.svg)
4+
35
**Deploy and invoke Lambda functions in LocalStack directly from VSCode.**
46

5-
> We encourage you to test the current preview version and share your feedback with us.
7+
👉 Get our [LocalStack VSCode Extension](https://marketplace.visualstudio.com/items?itemName=LocalStack.localstack) from the Visual Studio Marketplace.
8+
9+
> 🧪 We encourage you to test the current preview version and share your feedback with us.
610
711
## Features
812

913
Deploy Python Lambda function directly from your code using an [AWS SAM](https://github.com/aws/serverless-application-model) or [AWS CloudFormation](https://aws.amazon.com/cloudformation/resources/templates/) template:
10-
<!-- TODO: add animation gif of deployment -->
11-
<!-- TODO: update image URLs to HTTPs to work within the Marketplace -->
12-
![Deploy Lambda function](resources/images/deploy-lambda.png)
14+
![Deploy Lambda function](resources/images/deploy-lambda.gif)
1315

1416
Invoke Lambda function:
15-
![Invoke Lambda function](resources/images/invoke-lambda.png)
17+
![Invoke Lambda function](resources/images/invoke-lambda.gif)
1618

1719
## Requirements
1820

@@ -21,7 +23,9 @@ Invoke Lambda function:
2123

2224
## Known Issues
2325

24-
None
26+
* Limitations
27+
* The CodeLens for "Deploy Lambda function" always appears at the first line of each Python file
28+
* "Invoke Lambda function" currently only works in the region `us-east-1` and with an empty payload.
2529

2630
## Feedback
2731

package-lock.json

Lines changed: 3 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "localstack",
33
"displayName": "LocalStack",
44
"description": "Deploy Lambda functions to LocalStack",
5-
"version": "0.1.0",
5+
"version": "0.1.1",
66
"preview": true,
77
"publisher": "LocalStack",
88
"engines": {
@@ -14,7 +14,7 @@
1414
"keywords": ["LocalStack", "Lambda", "python", "AWS SAM", "CloudFormation"],
1515
"icon": "resources/localstack-icon-256x256.png",
1616
"galleryBanner": {
17-
"color": "#6B7CF5",
17+
"color": "#39227A",
1818
"theme": "dark"
1919
},
2020
"license": "Apache-2.0",

resources/images/deploy-lambda.gif

4.09 MB
Loading

resources/images/invoke-lambda.gif

162 KB
Loading

0 commit comments

Comments
 (0)