Skip to content

Improve readme and docs #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LukasGentele merged 2 commits into from
Sep 16, 2018
Merged

Improve readme and docs #202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4d52d3
improve README
Sep 16, 2018
43b13c3
improve README
Sep 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ curl -s "https://raw.githubusercontent.com/covexo/devspace/master/scripts/instal
del "%Temp%\install-devspace.bat"
```

**Note:** After running the install script, you should reopen the terminal window to refresh the environment variables.
**Note:** After running the install script, you should close and re-open your terminal window or IDE to refresh the environment variables.

### For Linux
```bash
Expand All @@ -47,11 +47,13 @@ curl --silent "https://api.github.com/repos/covexo/devspace/releases/latest" | s
```

## [Quickstart](https://devspace.covexo.com/docs/getting-started/quickstart.html)
To get started with the DevSpace CLI, you only need a Kubernetes cluster. If you do not have one yet, take a look at our [Minikube Install Guide](https://devspace.covexo.com/docs/advanced/kubernetes.html) or [request access to the private beta of the DevSpace Cloud](https://devspace-cloud.com/).

The DevSpace CLI allows you to create a DevSpace for any existing project with just a single command:
```
devspace up
```
Take a look at the [Getting Started Guide](https://devspace.covexo.com/docs/getting-started/quickstart.html) on our documentation page to start coding with a DevSpace.
Take a look at the [Getting Started Guide](https://devspace.covexo.com/docs/getting-started/quickstart.html) on our documentation page to see how to get started with a DevSpace.

**Note:** Don't worry, with you can use `devspace reset` to reset your project and go back to local development.

Expand Down
2 changes: 1 addition & 1 deletion scripts/installer-win.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ echo 1. Downloading executable...
set INSTALL_PATH=%INSTALL_DIR%\devspace.exe
if not exist %INSTALL_PATH% curl -L %DEVSPACE_EXE% >%INSTALL_PATH% || echo Unable to download latest release && exit /B 1

echo 2. Running installation...
echo 2. Running installation... (this may take 1-2 minutes)
start /WAIT /D %INSTALL_DIR% /B devspace.exe "install"

if "%errorlevel%" == "0" (
Expand Down