Skip to content

Commit a2c73ab

Browse files
authored
chore: More complete language examples (#592)
1 parent 146886f commit a2c73ab

File tree

1 file changed

+51
-6
lines changed

1 file changed

+51
-6
lines changed

README.md

Lines changed: 51 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,14 @@ You can also create your own provider by implementing `IRunnerProvider`.
6565
```
6666
### Use
6767
```python
68+
from aws_cdk import App, Stack
6869
from cloudsnorkel.cdk_github_runners import GitHubRunners
6970

70-
GitHubRunners(self, "runners")
71+
app = App()
72+
stack = Stack(app, "github-runners")
73+
GitHubRunners(stack, "runners")
74+
75+
app.synth()
7176
```
7277
</details>
7378
<details><summary>TypeScript or JavaScript</summary>
@@ -79,9 +84,14 @@ You can also create your own provider by implementing `IRunnerProvider`.
7984
```
8085
### Use
8186
```typescript
87+
import { App, Stack } from 'aws-cdk-lib';
8288
import { GitHubRunners } from '@cloudsnorkel/cdk-github-runners';
8389

84-
new GitHubRunners(this, "runners");
90+
const app = new App();
91+
const stack = new Stack(app, 'github-runners');
92+
new GitHubRunners(stack, 'runners');
93+
94+
app.synth();
8595
```
8696
</details>
8797
<details><summary>Java</summary>
@@ -96,9 +106,19 @@ You can also create your own provider by implementing `IRunnerProvider`.
96106
```
97107
### Use
98108
```java
109+
import software.amazon.awscdk.App;
110+
import software.amazon.awscdk.Stack;
99111
import com.cloudsnorkel.cdk.github.runners.GitHubRunners;
100112

101-
GitHubRunners.Builder.create(this, "runners").build();
113+
public class Example {
114+
public static void main(String[] args){
115+
App app = new App();
116+
Stack stack = new Stack(app, "github-runners");
117+
GitHubRunners.Builder.create(stack, "runners").build();
118+
119+
app.synth();
120+
}
121+
}
102122
```
103123
</details>
104124
<details><summary>Go</summary>
@@ -110,9 +130,21 @@ You can also create your own provider by implementing `IRunnerProvider`.
110130
```
111131
### Use
112132
```go
113-
import "github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners"
133+
package main
134+
135+
import (
136+
"github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners"
137+
"github.com/aws/aws-cdk-go/awscdk/v2"
138+
"github.com/aws/jsii-runtime-go"
139+
)
140+
141+
func main() {
142+
app := awscdk.NewApp(nil)
143+
stack := awscdk.NewStack(app, jsii.String("github-runners"), &awscdk.StackProps{})
144+
cloudsnorkelcdkgithubrunners.NewGitHubRunners(stack, jsii.String("runners"), &cloudsnorkelcdkgithubrunners.GitHubRunnersProps{})
114145

115-
NewGitHubRunners(this, jsii.String("runners"))
146+
app.Synth(nil)
147+
}
116148
```
117149
</details>
118150
<details><summary>.NET</summary>
@@ -124,9 +156,22 @@ You can also create your own provider by implementing `IRunnerProvider`.
124156
```
125157
### Use
126158
```csharp
159+
using Amazon.CDK;
127160
using CloudSnorkel;
128161

129-
new GitHubRunners(this, "runners");
162+
namespace Example
163+
{
164+
sealed class Program
165+
{
166+
public static void Main(string[] args)
167+
{
168+
var app = new App();
169+
var stack = new Stack(app, "github-runners");
170+
new GitHubRunners(stack, "runners");
171+
app.Synth();
172+
}
173+
}
174+
}
130175
```
131176
</details>
132177
2. Use `GitHubRunners` construct in your code (starting with default arguments is fine)

0 commit comments

Comments
 (0)