Skip to content

Commit 81a010e

Browse files
committed
Update README.md
1 parent 906503c commit 81a010e

File tree

1 file changed

+9
-94
lines changed

1 file changed

+9
-94
lines changed

README.md

Lines changed: 9 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,12 @@
1919
</a>
2020
</p>
2121

22-
## Features
22+
<!-- ## Features -->
2323

24-
- **Deploy Applications**: Push your code directly to Zerops services with a single click
25-
- **VPN Connection Management**: Connect to your Zerops VPN directly from VS Code
26-
- **Project Configuration**: Initialize and configure Zerops projects and services
27-
- **Recipe Templates**: Clone and use ready-made project templates
28-
- **Documentation Access**: Access Zerops documentation directly within VS Code
29-
- **Web Interface Integration**: Open the Zerops dashboard, project pages, and service details in your browser
3024

3125
## Installation
3226

33-
1. Open VS Code
34-
2. Go to Extensions (Ctrl+Shift+X)
35-
3. Search for "Zerops"
36-
4. Click Install
37-
5. Reload VS Code when prompted
27+
Install from VS Code or Windsurf Extensions marketplace (Ctrl+Shift+X) by searching for "zvsc".
3828

3929
### Prerequisites
4030

@@ -43,90 +33,15 @@
4333

4434
## Authentication
4535

46-
### Generate a Personal Access Token
36+
### Personal Access Token
37+
Generate a token at [Settings > Access Token Management](https://app.zerops.io/settings/access-token-management) with a descriptive name. Copy it immediately as it's shown only once.
4738

48-
1. Navigate to [Settings > Access Token Management](https://app.zerops.io/settings/access-token-management) in your Zerops account
49-
2. Click "Generate New Token"
50-
3. Set an appropriate name and click "Generate Token"
51-
4. Copy the displayed token (it will be shown only once)
39+
## Support and Resources
5240

53-
### Login to Zerops from VS Code
54-
55-
1. Open the Command Palette (Ctrl+Shift+P)
56-
2. Type "Zerops: Login" and select it
57-
3. Paste your access token when prompted
58-
59-
Alternatively, use the Zerops menu in the status bar by clicking the rocket option.
60-
61-
## Usage
62-
63-
### Status Bar Controls
64-
65-
The extension adds several options to your VS Code status bar:
66-
67-
- **Zerops**: Main menu for all Zerops commands
68-
- **zPush**: Push your code to Zerops
69-
- **zService**: Explore service options
70-
- **zGUI**: Open Zerops dashboard
71-
- **zVpn Up**: Connect to Zerops VPN
72-
- **zVpn Down**: Disconnect from Zerops VPN
73-
74-
### Main Commands
75-
76-
#### Deploying Code
77-
78-
1. Click the "Zerops" option in the status bar
79-
2. Select "Push to Zerops"
80-
3. Select your target service (or configure one if not set up)
81-
82-
#### Accessing Zerops Dashboard
83-
84-
1. Click the "Zerops" option
85-
2. Select "Explore GUI" and then "Open GUI"
86-
87-
#### Using Recipe Templates
88-
89-
1. Click the "Zerops" option
90-
2. Select "Clone Recipe"
91-
3. Choose from available templates
92-
93-
#### Configuration Management
94-
95-
1. Click the "Zerops" option
96-
2. Select "Init Configurations"
97-
3. Choose "Init zerops.yml" or "Init zerops-project-import.yml"
98-
99-
## Project Configuration
100-
101-
To configure your project, set up the service and project IDs:
102-
103-
1. Click the "Zerops" option
104-
2. Select "Settings"
105-
3. Choose "Add Service ID" or "Add Project ID"
106-
4. Enter the IDs from your Zerops dashboard
107-
108-
## Troubleshooting
109-
110-
### VPN Connection Issues
111-
112-
If you're having trouble connecting to the VPN:
113-
1. Ensure WireGuard is installed and running
114-
2. Check that your Project ID is correctly configured
115-
3. Try disconnecting and reconnecting
116-
117-
### Authentication Problems
118-
119-
If you're experiencing login issues:
120-
1. Verify your access token is valid
121-
2. Try logging out and logging back in
122-
3. Regenerate a new token if needed
123-
124-
## Support and Feedback
125-
126-
- **Documentation**: Visit [Zerops Documentation](https://docs.zerops.io)
127-
- **Community**: Join our [Discord server](https://discord.gg/zeropsio) for support
128-
- **Issues**: Report bugs or request features on our [GitHub repository](https://github.com/zeropsio/zvsc/issues)
129-
- **Contact**: Email us at [[email protected]](mailto:[email protected])
41+
- [📚 Documentation](https://docs.zerops.io)
42+
- [💬 Discord Community](https://discord.gg/zeropsio)
43+
- [🐞 GitHub Issues](https://github.com/zeropsio/zvsc/issues)
44+
- [✉️ Email Support](mailto:[email protected])
13045

13146
## License
13247

0 commit comments

Comments
 (0)