@@ -5,30 +5,29 @@ open a preview URL, and tear everything down from Java.
55
66## Your first sandbox
77
8- The first Maven Central release is being prepared. For now, install the public
9- source checkout locally with Java 17+ and Maven 3.9+:
8+ Install the public source checkout locally with Java 17+ and Maven 3.9+:
109
1110``` sh
1211git clone https://github.com/NodeOps-app/createos-java-sdk.git
1312cd createos-java-sdk
1413mvn install
1514```
1615
17- Then add the locally installed SDK to your project's ` pom.xml ` :
16+ Then add the locally installed SDK to your project's ` pom.xml ` . Replace
17+ ` YOUR_INSTALLED_VERSION ` with the version in the checkout's ` pom.xml ` :
1818
1919``` xml
2020<dependencies >
2121 <dependency >
2222 <groupId >network.nodeops</groupId >
2323 <artifactId >createos-java-sdk</artifactId >
24- <version >0.1.1-SNAPSHOT </version >
24+ <version >YOUR_INSTALLED_VERSION </version >
2525 </dependency >
2626</dependencies >
2727```
2828
29- No package-download token or extra Maven repository is needed. Once Maven
30- Central publishes a release, you can use its version in the dependency above
31- without building from source.
29+ No package-download token or extra Maven repository is needed for the local
30+ installation.
3231
3332The compile-checked [ hello-world example] ( examples/src/main/java/network/nodeops/createos/examples/helloworld/HelloWorld.java )
3433creates a sandbox, runs a command, prints its output, and always destroys the
@@ -111,8 +110,8 @@ the build enforces the [Google Java Style Guide](https://google.github.io/styleg
111110### SDKs
112111
113112- [ TypeScript] ( https://github.com/NodeOps-app/createos-sandbox-sdk )
114- - [ Python] ( https://github.com/NodeOps-app/createos-python-sdk )
115113- [ Go] ( https://github.com/NodeOps-app/createos-go-sdk )
114+ - [ Python] ( https://github.com/NodeOps-app/createos-python-sdk )
116115- [ C#] ( https://github.com/NodeOps-app/createos-csharp-sdk )
117116- [ Java] ( https://github.com/NodeOps-app/createos-java-sdk )
118117- [ Rust] ( https://github.com/NodeOps-app/createos-rust-sdk )
@@ -313,6 +312,20 @@ The `Sandbox` handle caches the latest server projection safely. Lifecycle
313312mutations and ` refresh() ` update it, while ` id() ` , ` name() ` , ` status() ` ,
314313` ipAddress() ` , and ` data() ` provide thread-safe reads.
315314
315+ ## Build reusable templates
316+
317+ Build a sandbox root filesystem from a Dockerfile, follow its build logs, and
318+ wait until the template is ready before creating a sandbox from its ID. See the
319+ [ custom template example] ( examples/src/main/java/network/nodeops/createos/examples/customtemplate/CustomTemplate.java )
320+ for the complete workflow and cleanup.
321+
322+ ## Automate a desktop
323+
324+ The desktop root filesystem supports screenshots, mouse and keyboard control,
325+ clipboard access, and temporary noVNC connections. The
326+ [ desktop example] ( examples/src/main/java/network/nodeops/createos/examples/desktop/Desktop.java )
327+ exercises these operations.
328+
316329## Errors stay inspectable
317330
318331``` java
@@ -369,12 +382,6 @@ CI compiles the SDK and every example on Java 17, 21, and 25; runs JUnit and
369382the coverage gate; verifies Google Java formatting; requires zero Checkstyle
370383warnings; and builds source and Javadoc JARs.
371384
372- ## Releases
373-
374- Version [ ` 0.1.0 ` ] ( https://github.com/NodeOps-app/createos-java-sdk/releases/tag/v0.1.0 )
375- remains available as a GitHub Release, but its GitHub Maven package was removed.
376- No Maven Central version is available yet.
377-
378385## Package layout
379386
380387``` text
0 commit comments