Skip to content

Commit c753374

Browse files
authored
doc: update readme (#700)
1 parent 884d368 commit c753374

File tree

1 file changed

+47
-24
lines changed

1 file changed

+47
-24
lines changed

README.md

Lines changed: 47 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,22 @@
77

88
# Scaleway CLI (v2)
99

10-
**:warning: This version is under active development, keep in mind that things can break. We advise you to not use this version in production.**
10+
**:warning: This version is under active development, keep in mind that things can break.**
1111

1212
Scaleway is a single way to create, deploy and scale your infrastructure in the cloud. We help thousands of businesses to run their infrastructures easily.
1313

1414
If you are looking for a stable version, [see the version 1](https://github.com/scaleway/scaleway-sdk-go).
1515

16+
# Getting Started
17+
18+
After you [installed](#Installation) the latest release just run the initialization command and let yourself be guided! :dancer:
19+
20+
```bash
21+
scw init
22+
```
23+
24+
It will set up your profile, the authentication, and the auto-completion.
25+
1626
# Installation
1727

1828
<!--- TODO:
@@ -47,24 +57,41 @@ TODO: Add other package managers:
4757

4858
## Manually
4959

50-
### Compiled Release Binaries
51-
52-
We provide [static-compiled release binaries](https://github.com/scaleway/scaleway-cli/releases/latest) for darwin (macOS), GNU/Linux, and Windows platforms.
60+
### Released Binaries
5361

62+
We provide [static-compiled binaries](https://github.com/scaleway/scaleway-cli/releases/latest) for darwin (macOS), GNU/Linux, and Windows platforms.
5463
You just have to download the binary compatible with your platform to a directory available in your `PATH`:
64+
65+
#### Mac OS
66+
5567
```bash
56-
# /usr/local/bin is in my PATH
68+
# Check that /usr/local/bin is in your PATH
5769
echo $PATH
5870
/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
5971

60-
# With wget
61-
wget "https://github.com/scaleway/scaleway-cli/releases/download/v2.0.0-alpha.1/scw-darwin-amd64" -O /usr/local/bin/scw
72+
# Download the release from github
73+
sudo curl -o /usr/local/bin/scw -L "https://github.com/scaleway/scaleway-cli/releases/download/v2.0.0-alpha1/scw-darwin-x86_64"
6274

63-
# With curl
64-
curl -o /usr/local/bin/scw -L https://github.com/scaleway/scaleway-cli/releases/download/v2.0.0-alpha.1/scw-darwin-amd64
75+
# Init the CLI
76+
scw init
6577
```
6678

67-
For Windows, [this official guide](https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/ee537574(v=office.14)) explains how to add tools to your `PATH`.
79+
#### Linux
80+
81+
```bash
82+
# Download the release from github
83+
sudo curl -o /usr/local/bin/scw -L "https://github.com/scaleway/scaleway-cli/releases/download/v2.0.0-alpha1/scw-linux-x86_64"
84+
85+
# Init the CLI
86+
scw init
87+
```
88+
89+
#### Windows
90+
91+
You can download the last release here: https://github.com/scaleway/scaleway-cli/releases/download/v2.0.0-alpha1/scw-windows-x86_64<br/>
92+
[This official guide](https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/ee537574(v=office.14)) explains how to add tools to your `PATH`.
93+
94+
<!-- TODO:
6895
6996
### Debian
7097
@@ -80,7 +107,6 @@ Then, run the installation and remove the `.deb` file:
80107
dpkg -i /tmp/scw.deb && rm -f /tmp/scw.deb
81108
```
82109
83-
<!-- TODO:
84110
## With a Docker Image
85111
86112
For each release, we deliver a tagged image on the [Scaleway Docker Hub](https://hub.docker.com/r/scaleway/cli/tags) so can run `scw` in a sandboxed way: _Coming soon..._
@@ -92,28 +118,23 @@ docker run scaleway/cli version
92118

93119
## Build Locally
94120

95-
If you have a >= Go 1.11 environment, you can install the `HEAD` version to test the latest features or to [contribute](CONTRIBUTING.md).
121+
If you have a >= Go 1.13 environment, you can install the `HEAD` version to test the latest features or to [contribute](CONTRIBUTING.md).
96122
Note that this development version could include bugs, use [tagged releases](https://github.com/scaleway/scaleway-cli/releases/latest) if you need stability.
97123

98124
```bash
99125
go get github.com/scaleway/scaleway-cli/cmd/scw
100126
```
101127

102-
Dependancies: We only use go [Go Modules](https://github.com/golang/go/wiki/Modules) with vendoring.
103-
104-
# Getting Started
128+
Dependencies: We only use go [Go Modules](https://github.com/golang/go/wiki/Modules) with vendoring.
105129

106-
Just run the initialization command and let yourself be guided! :dancer:
130+
# Examples
107131

108-
```bash
109-
scw init
132+
## Create an instance server
133+
```
134+
scw instance server create type=DEV1-S image=ubuntu-bionic zone=fr-par-1 tags.0="scw-cli"
110135
```
111136

112-
It will set up your profile, the authentication, and the auto-completion.
113-
114-
# Examples
115-
116-
TODO: Add a list of examples here.
137+
TODO: Add more examples here.
117138

118139
# Tutorials
119140

@@ -127,4 +148,6 @@ If you are looking for a way to contribute please read [CONTRIBUTING.md](CONTRIB
127148
# Reach Us
128149

129150
We love feedback.
130-
Feel free to reach us on [Scaleway Slack community](https://slack.scaleway.com/), we are waiting for you on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource).
151+
Don't hesitate to open a [Github issue](https://github.com/scaleway/scaleway-cli/issues/new) or
152+
feel free to reach us on [Scaleway Slack community](https://slack.scaleway.com/),
153+
we are waiting for you on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource).

0 commit comments

Comments
 (0)