Skip to content

Commit 82f48c1

Browse files
authored
chore(documentation): update readme to fix issues (#728)
* chore(documentation): update readme to fix issues
1 parent 93a767f commit 82f48c1

File tree

1 file changed

+35
-5
lines changed

1 file changed

+35
-5
lines changed

Diff for: README.md

+35-5
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
[![PyPI version](https://img.shields.io/pypi/v/cdklabs.generative-ai-cdk-constructs)](https://pypi.org/project/cdklabs.generative-ai-cdk-constructs/)
1414
[![npm version](https://img.shields.io/npm/v/@cdklabs/generative-ai-cdk-constructs)](https://www.npmjs.com/package/@cdklabs/generative-ai-cdk-constructs)
1515
[![NuGet Version](https://img.shields.io/nuget/v/Cdklabs.GenerativeAiCdkConstructs)](https://nuget.info/packages/Cdklabs.GenerativeAiCdkConstructs)
16-
[![Maven Central Version](https://img.shields.io/maven-central/v/io.github.cdklabs/generative-ai-cdk-constructs)(https://central.sonatype.com/artifact/io.github.cdklabs/generative-ai-cdk-constructs)]
16+
[![Maven Central Version](https://img.shields.io/maven-central/v/io.github.cdklabs/generative-ai-cdk-constructs)](https://central.sonatype.com/artifact/io.github.cdklabs/generative-ai-cdk-constructs)
1717
[![Go Version](https://img.shields.io/github/v/tag/awslabs/generative-ai-cdk-constructs?label=go&color=orange)](https://pkg.go.dev/github.com/cdklabs/generative-ai-cdk-constructs-go/generative-ai-cdk-constructs)
1818

1919
## Table of contents
@@ -52,7 +52,8 @@ If you want to add a new construct to the library, check out our [design guideli
5252

5353
## Getting Started
5454

55-
### For TypeScript
55+
<details>
56+
<summary><i>TypeScript</i></summary>
5657

5758
- Create or use an existing CDK application in TypeScript.
5859
- `cdk init app --language typescript`
@@ -61,7 +62,10 @@ If you want to add a new construct to the library, check out our [design guideli
6162
- Import the library:
6263
- `import * as genai from '@cdklabs/generative-ai-cdk-constructs';`
6364

64-
### For Python
65+
</details>
66+
67+
<details>
68+
<summary><i>Python</i></summary>
6569

6670
- Create or use an existing CDK application in Python
6771
- `cdk init app --language python`
@@ -70,7 +74,10 @@ If you want to add a new construct to the library, check out our [design guideli
7074
- Import the library:
7175
- `import cdklabs.generative_ai_cdk_constructs`
7276

73-
### For NuGet
77+
</details>
78+
79+
<details>
80+
<summary><i>NuGet</i></summary>
7481

7582
- Create or use an existing CDK application in Python
7683
- `cdk init app --language csharp`
@@ -79,16 +86,39 @@ If you want to add a new construct to the library, check out our [design guideli
7986
- Use the namespace:
8087
- `using Cdklabs.GenerativeAiCdkConstructs;`
8188

82-
### For Go
89+
</details>
90+
91+
<details>
92+
<summary><i>Go</i></summary>
93+
8394
- Create or use an existing CDK application in Python
8495
- `cdk init app --language go`
8596
- Get the module:
8697
- `go get github.com/cdklabs/generative-ai-cdk-constructs-go/generative-ai-cdk-constructs`
8798
- Import the library:
8899
- `import "github.com/cdklabs/generative-ai-cdk-constructs-go/generative-ai-cdk-constructs"`
89100

101+
90102
_NOTE: The [Go distribution repository](https://github.com/cdklabs/generative-ai-cdk-constructs-go), distributes the JSII tar gzipped versioned source from the [source repository](https://github.awslabs/generative-ai-cdk-constructs)_
91103

104+
</details>
105+
106+
<details>
107+
<summary><i>Java</i></summary>
108+
109+
- Create or use an existing CDK application in Java
110+
- cdk init app --language java
111+
- Add the dependency into the `pom.xml`
112+
```
113+
<dependency>
114+
<groupId>io.github.cdklabs</groupId>
115+
<artifactId>generative-ai-cdk-constructs</artifactId>
116+
<version>Get the latest version and insert it here</version>
117+
</dependency>
118+
```
119+
120+
</details>
121+
92122
Refer to the documentation for additional guidance on a particular construct: [Catalog](#catalog)
93123

94124
## Catalog

0 commit comments

Comments
 (0)