Skip to content

Commit 17adf18

Browse files
authored
Mention Quarkus ORAS (#288)
2 parents 972c168 + 340c4de commit 17adf18

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ Javadoc is published from main branch into: https://oras-project.github.io/oras-
3636
</dependency>
3737
```
3838

39+
### Quarkus
40+
41+
Quarkus users can use the extension `quarkus-oras` to use the SDK in their applications.
42+
43+
Follow the [Quarkus ORAS documentation](https://docs.quarkiverse.io/quarkus-oras/dev/index.html#) to get started with Quarkus.
44+
3945
### Only for SNAPSHOTS (only for testing)
4046

4147
GitHub requires authentication to download packages. You can use a personal access token to authenticate with GitHub Packages. To authenticate with GitHub Packages, you need to update your `~/.m2/settings.xml` file to include your personal access token.
@@ -69,27 +75,27 @@ Then on your `pom.xml`
6975
Using default existing login existing credentials (e.g. `~/.docker/config.json`)
7076

7177
```java
72-
Registry registry = Registry.Builder.builder().defaults().build();
78+
Registry registry = Registry.builder().defaults().build();
7379
```
7480

7581
Using username and password
7682

7783
```java
78-
Registry registry = Registry.Builder.builder().defaults("username", "password").build();
84+
Registry registry = Registry.builder().defaults("username", "password").build();
7985
```
8086

8187
### Push an Artifact
8288

8389
```java
8490
LocalPath artifact = LocalPath.of("my-file.txt");
85-
Registry registry = Registry.Builder.builder().insecure().build();
91+
Registry registry = Registry.builder().insecure().build();
8692
Manifest manifest = registry.pushArtifact(ContainerRef.parse("localhost:5000/hello:v1"), artifact);
8793
```
8894

8995
### Pull an Artifact
9096

9197
```java
92-
Registry registry = Registry.Builder.builder().insecure().build();
98+
Registry registry = Registry.builder().insecure().build();
9399
registry.pullArtifact(ContainerRef.parse("localhost:5000/hello:v1"), Path.of("folder"), false);
94100
```
95101

0 commit comments

Comments
 (0)