Skip to content

Commit 7dc8f92

Browse files
author
Frank Taubert
committed
update documentation
1 parent 2afd56b commit 7dc8f92

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=VBXHBYFU44T5W&source=url)
2-
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/virtomize/uii-go-api/blob/master/LICENSE)
2+
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/virtomize/uii-python-api/blob/master/LICENSE)
33
[![Website](https://img.shields.io/badge/%40-Virtomize-%231e828c)](https://virtomize.com)
44
[![Twitter](https://badgen.net/badge/icon/twitter?icon=twitter&label)](https://twitter.com/virtomize)
55
[![LinkedIn](https://img.shields.io/badge/linkedIn-%20-blue.svg?style=social&logo=linkedin)](https://www.linkedin.com/company/virtomize/)
@@ -12,19 +12,19 @@ Building an ISO requires two steps.
1212
1. Create a client.
1313
This requires the API token created in the UI (see below).
1414

15-
```python
16-
import uiipythonapi as uii
17-
api = uii.Client("token here")
18-
```
15+
```python
16+
import uiipythonapi as uii
17+
api = uii.Client("token here")
18+
```
1919

2020
2. Building the ISO by using `build` on the client object.
2121

22-
```python
23-
err = api.build("debian10.iso", "debian", "10", "x86_64", "hostnamehere", [{
24-
"dhcp": True,
25-
"nointernet": False,
26-
}])
27-
```
22+
```python
23+
err = api.build("debian10.iso", "debian", "10", "x86_64", "hostnamehere", [{
24+
"dhcp": True,
25+
"nointernet": False,
26+
}])
27+
```
2828

2929
`build` requires the following parameters:
3030
- A path to the output file
@@ -35,16 +35,16 @@ err = api.build("debian10.iso", "debian", "10", "x86_64", "hostnamehere", [{
3535

3636
## Register an API token
3737
Before using this client library, you need to register an API token under your account.
38-
For this, login into the [website](virtomize.com) and go to the "API-Token" tab.
38+
For this, login into the [website](https://uii.virtomize.com/) and go to the "API-Token" tab.
3939

40-
![API-Token tab](https://github.com/Virtomize/uii_go_api/blob/60f79a50fc429f630eba553aaf057e6daa12ef97/doc/api-token.png "API-Token tab")
40+
![API-Token tab](https://github.com/Virtomize/uii-go-api/blob/master/doc/api-token.png "API-Token tab")
4141

4242
There, create a new API token by clicking "Create" and give it a name. Then click save.
43-
![Create a token](https://github.com/Virtomize/uii_go_api/blob/60f79a50fc429f630eba553aaf057e6daa12ef97/doc/api-token-create.png "Create a token")
43+
![Create a token](https://github.com/Virtomize/uii-go-api/blob/master/doc/api-token-create.png "Create a token")
4444

4545
A new token will be created.
4646
Copy this token, as it will be hidden, once you log out.
4747
There, create a new API token by clicking "Create" and give it a name. Then click save.
48-
![Save token](https://github.com/Virtomize/uii_go_api/blob/60f79a50fc429f630eba553aaf057e6daa12ef97/doc/api-token-created.png "Save token")
48+
![Save token](https://github.com/Virtomize/uii-go-api/blob/master/doc/api-token-created.png "Save token")
4949

5050

0 commit comments

Comments
 (0)