Skip to content

Commit 86cb560

Browse files
authored
Merge pull request #9 from upsun/update_readme
Improve Readme
2 parents 44ad74d + 63f986e commit 86cb560

File tree

3 files changed

+45
-7
lines changed

3 files changed

+45
-7
lines changed

README.md

Lines changed: 45 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,60 @@
1-
# Upsun (CLI) extension
1+
# VSCode Upsun
22

33
Upsun is the Cloud Application Platform that lets developers focus on building great applications, not infrastructure.
4-
Upsun is our analyst-recognized, developer-friendly, secure, sustainable, and enterprise-grade Cloud Application Platform.
54

6-
Visit Upsun's [website](https://upsun.com/) for more information about the company.
5+
This extension has a command palette to run Upsun CLI commands directly from within **VSCode**, without needing to switch to a shell.
6+
7+
![Preview Extension](resources/images/preview-light.png)
8+
9+
Visit [website](https://upsun.com/) for more information about Upsun.
710

811
## Features
912

10-
- Open public URLs of your project routes
13+
- Install Upsun CLI
14+
- Install 3th party tools (ClonSun, ConvSun, FastSun...)
15+
- Open/list public URLs of your project routes
1116
- Open Upsun console
1217
- Open SSH session
18+
- See logs container (syslog, http_access...)
19+
- Enable/Disable project environment
20+
- Redeploy a environement
21+
- Yaml configuration validation
22+
23+
All these features are designed to work in all VSCode based editors such as VSCode Insiders, VSCodium, vscode.dev, [cursor.com](https://www.cursor.com/how-to-install-extensions), and GitHub Codespaces.
24+
25+
### Install Upsun CLI
26+
27+
This extension works on top of the upsun CLI. After installing the extension you need to install the CLI. Go to walkthout...
28+
29+
### Install 3th party tools
30+
31+
- [ConvSun](https://github.com/upsun/convsun) : Tool for convert Platform.sh configuration to upsun configuration (not just a merge !)
32+
- [ClonSun](https://github.com/upsun/clonsun) : Tool for clone a project (any provider of Platform.sh) to another project (created by tool).
33+
- [FastSun](https://github.com/upsun/fastsun) : UI to manage Fastly/CDN.
34+
35+
### Open/list public preview URL, Upsun console, SSH
36+
37+
Quick access (cmd+p) to:
38+
- List of web-site URL define in route section.
39+
- Open upsun console.
40+
- Open terminal (bult-in VScode) on SSH to project.
41+
- and more...
1342

1443
## Requirements
1544

16-
1. To use this extensions you need to [install Upsun's CLI](https://docs.upsun.com/development/cli.html#1-install)
17-
2. Install Upsun's CLI extension for Visual Studio Code
45+
- [Upsun's CLI](https://docs.upsun.com/administration/cli.html#1-install) (use walkthroughs wizard)
46+
- Vscode.git (installed with this extension)
47+
- Redhat.vscode-yaml (installed with this extension)
48+
49+
## Demo
50+
51+
Here's a quick rapid-fire demo GIF of some of the features of this extension.
52+
53+
![TODO](resources/images/preview-light.png)
54+
55+
## Contribute
1856

19-
## Building locally
57+
### Building locally
2058

2159
```
2260
npm install

resources/images/preview-dark.png

144 KB
Loading

resources/images/preview-light.png

146 KB
Loading

0 commit comments

Comments
 (0)