Skip to content

Commit 8fba538

Browse files
author
gentele
committed
improve README
1 parent f230439 commit 8fba538

1 file changed

Lines changed: 21 additions & 2 deletions

File tree

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,28 @@ Program inside any Kubernetes cluster (e.g. minikube, self-hosted or cloud platf
2020
coming soon
2121

2222
## Installation
23+
These commands will install the devspace CLI and add it to the PATH environment variable. For more details, see the full [Install Guide](https://devspace.covexo.com/docs/getting-started/installation.html).
24+
25+
### For Windows
26+
1. Open CMD with **admin rights**.
27+
2. Run this install script:
28+
```cmd
29+
curl -s "https://raw.githubusercontent.com/covexo/devspace/master/scripts/installer-win.bat" >"%Temp%\install-devspace.bat"
30+
"%Temp%\install-devspace.bat" "%PROGRAMFILES%\devspace"
31+
del "%Temp%\install-devspace.bat"
32+
```
33+
34+
**Note:** After running the install script, you should reopen the terminal window to refresh the environment variables.
35+
36+
### For Linux
37+
```bash
38+
curl --silent "https://api.github.com/repos/covexo/devspace/releases/latest" | sed -nr 's!.*"(https://github.com[^"]*devspace-linux-amd64)".*!\1!p' | xargs -n 1 curl -L -o devspace && chmod +x devspace && sudo mv devspace /usr/local/bin
39+
```
2340

41+
### For Mac
42+
```bash
43+
curl --silent "https://api.github.com/repos/covexo/devspace/releases/latest" | sed -nr 's!.*"(https://github.com[^"]*devspace-darwin-amd64)".*!\1!p' | xargs -n 1 curl -L -o devspace && chmod +x devspace && sudo mv devspace /usr/local/bin
44+
```
2445

2546
## Quickstart
2647
The DevSpace CLI allows you to create a DevSpace for any existing project with just a single command:
@@ -68,5 +89,3 @@ This project is mainly written in Golang. To contribute code,
6889

6990
## License
7091
You can use the DevSpace CLI for any private or commercial projects because it is licensed unter the Apache 2.0 open source license.
71-
72-
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fcovexo%2Fdevspace.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fcovexo%2Fdevspace?ref=badge_large)

0 commit comments

Comments
 (0)