Skip to content

Commit cb6109c

Browse files
authored
Update README documentation (#146)
Signed-off-by: Alexander Dahmen <[email protected]>
1 parent a9518b8 commit cb6109c

File tree

3 files changed

+12
-75
lines changed

3 files changed

+12
-75
lines changed

README.md

Lines changed: 4 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,10 @@ Apache 2.0
2525

2626
## Installing
2727

28-
This package is available for several languages/platforms:
28+
> [!NOTE]
29+
> Currently those packages are not available via the mentioned packages managers but can be installed locally by using the generated sdks directly.
30+
> Keep in mind that this is in ALPHA state and only the Resource Manager and IaaS service is supported.
31+
> E.g. in order to create and install the TypeScript SDK you can use the following [guide](./examples/ts/README.md).
2932
3033
### Node.js (JavaScript/TypeScript)
3134

@@ -41,30 +44,6 @@ or `yarn`:
4144
yarn add @stackitcloud/pulumi-stackit
4245
```
4346

44-
### Python
45-
46-
To use from Python, install using `pip`:
47-
48-
```bash
49-
pip install pulumi_stackit
50-
```
51-
52-
### Go
53-
54-
To use from Go, use `go get` to grab the latest version of the library:
55-
56-
```bash
57-
go get github.com/stackitcloud/pulumi-stackit/sdk
58-
```
59-
60-
### .NET
61-
62-
To use from .NET, install using `dotnet add package`:
63-
64-
```bash
65-
dotnet add package Pulumi.stackit
66-
```
67-
6847
## Getting started
6948

7049
A good starting point is the collection of examples in the [Examples](./examples/) folder.

docs/_index.md

Lines changed: 4 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,10 @@ Apache 2.0
3131

3232
## Installing
3333

34-
This package is available for several languages/platforms:
34+
> [!NOTE]
35+
> Currently those packages are not available via the mentioned packages managers but can be installed locally by using the generated sdks directly.
36+
> Keep in mind that this is in ALPHA state and only the Resource Manager and IaaS service is supported.
37+
> E.g. in order to create and install the TypeScript SDK you can use the following [guide](./examples/ts/README.md).
3538
3639
### Node.js (JavaScript/TypeScript)
3740

@@ -47,30 +50,6 @@ or `yarn`:
4750
yarn add @stackitcloud/pulumi-stackit
4851
```
4952

50-
### Python
51-
52-
To use from Python, install using `pip`:
53-
54-
```bash
55-
pip install pulumi_stackit
56-
```
57-
58-
### Go
59-
60-
To use from Go, use `go get` to grab the latest version of the library:
61-
62-
```bash
63-
go get github.com/stackitcloud/pulumi-stackit/sdk
64-
```
65-
66-
### .NET
67-
68-
To use from .NET, install using `dotnet add package`:
69-
70-
```bash
71-
dotnet add package Pulumi.stackit
72-
```
73-
7453
## Example
7554

7655
{{< chooser language "typescript" >}}

sdk/python/README.md

Lines changed: 4 additions & 25 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)