feat: update readme

Cargo.lock

@@ -309,7 +309,7 @@ dependencies = [
 
 [[package]]
 name = "dagger-sdk"
-version = "0.2.16"
+version = "0.2.17"
 dependencies = [
  "base64",
  "dagger-core",

README.md

@@ -1 +0,0 @@
-crates/dagger-sdk/README.md

README.md

@@ -0,0 +1,55 @@
+# dagger-sdk
+
+A dagger sdk written in rust for rust.
+
+## Examples
+
+See [examples](./crates/dagger-sdk/examples/)
+
+Run them like so
+
+```bash
+cargo run --example first-pipeline
+```
+
+The examples match the folder name in each directory in examples
+
+## Install
+
+Simply install like:
+
+```bash
+cargo add dagger-sdk
+```
+
+### Usage
+
+```rust
+#[tokio::main]
+async fn main() -> eyre::Result<()> {
+    let client = dagger_sdk::connect().await?;
+
+    let version = client
+        .container()
+        .from("golang:1.19")
+        .with_exec(vec!["go", "version"])
+        .stdout()
+        .await?;
+
+    println!("Hello from Dagger and {}", version.trim());
+
+    Ok(())
+}
+```
+
+And run it like a normal application:
+
+```bash
+cargo run
+```
+
+### Contributing
+
+See [CONTRIBUTING](./CONTRIBUTING.md)
+
+or just cargo make codegen

ci/Cargo.toml

@@ -8,6 +8,6 @@ edition = "2021"
 [dependencies]
 clap = "4.1.6"
 color-eyre = "0.6.2"
-dagger-sdk = { path = "../crates/dagger-sdk/", version = "^0.2.16" }
+dagger-sdk = { path = "../crates/dagger-sdk/", version = "^0.2.17" }
 eyre = "0.6.8"
 tokio = { version = "1.25.0", features = ["full"] }

crates/dagger-sdk/CHANGELOG.md

@@ -6,8 +6,57 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v0.2.17 (2023-03-13)
+
+### Bug Fixes
+
+ - <csr-id-1bfd084cd28e2b984c61de7f3f9a065cc41be007/> make sure tests have a command to execute
+ - <csr-id-5593fce2e16e0aa97a2e6843f15d3bb1121048f5/> remove unused imports
+ - <csr-id-c025d1742482d701946c292dcf104421d3cade8e/> add support for String as well
+ - <csr-id-d7317e5cf34ee84a7b092357f5fbb15cd2bae2e3/> add public tuple field and into func
+ - <csr-id-44fa0240f8197f49fdf942b5c3d89079b59195d1/> update rust crate futures to 0.3.27
+
+### Other
+
+ - <csr-id-f67928155f02076cbb41abd4010523879ff3caf1/> initial issue
+
+### Refactor
+
+ - <csr-id-2cc0231c5f29993081f0f7e15e44cac95a7d6086/> remove export and instead use exitcode
+ - <csr-id-9ba01396cb44ee02cf7a16008e3f0bdae9f78754/> move issues to actual tests and refactor
+ - <csr-id-e9e35edb1cb67eee8cc033212aba3b1888def78f/> move issues to another folder
+
+### Commit Statistics
+
+<csr-read-only-do-not-edit/>
+
+ - 9 commits contributed to the release over the course of 2 calendar days.
+ - 2 days passed between releases.
+ - 9 commits were understood as [conventional](https://www.conventionalcommits.org).
+ - 0 issues like '(#ID)' were seen in commit messages
+
+### Commit Details
+
+<csr-read-only-do-not-edit/>
+
+<details><summary>view details</summary>
+
+ * **Uncategorized**
+    - make sure tests have a command to execute ([`1bfd084`](https://github.com/kjuulh/dagger-rs/commit/1bfd084cd28e2b984c61de7f3f9a065cc41be007))
+    - remove unused imports ([`5593fce`](https://github.com/kjuulh/dagger-rs/commit/5593fce2e16e0aa97a2e6843f15d3bb1121048f5))
+    - remove export and instead use exitcode ([`2cc0231`](https://github.com/kjuulh/dagger-rs/commit/2cc0231c5f29993081f0f7e15e44cac95a7d6086))
+    - move issues to actual tests and refactor ([`9ba0139`](https://github.com/kjuulh/dagger-rs/commit/9ba01396cb44ee02cf7a16008e3f0bdae9f78754))
+    - add support for String as well ([`c025d17`](https://github.com/kjuulh/dagger-rs/commit/c025d1742482d701946c292dcf104421d3cade8e))
+    - move issues to another folder ([`e9e35ed`](https://github.com/kjuulh/dagger-rs/commit/e9e35edb1cb67eee8cc033212aba3b1888def78f))
+    - add public tuple field and into func ([`d7317e5`](https://github.com/kjuulh/dagger-rs/commit/d7317e5cf34ee84a7b092357f5fbb15cd2bae2e3))
+    - initial issue ([`f679281`](https://github.com/kjuulh/dagger-rs/commit/f67928155f02076cbb41abd4010523879ff3caf1))
+    - update rust crate futures to 0.3.27 ([`44fa024`](https://github.com/kjuulh/dagger-rs/commit/44fa0240f8197f49fdf942b5c3d89079b59195d1))
+</details>
+
 ## v0.2.16 (2023-03-10)
 
+<csr-id-e642778d9028726dfb07217814e15ad1dd3b83f2/>
+
 ### Chore
 
  - <csr-id-e642778d9028726dfb07217814e15ad1dd3b83f2/> fix tasks
@@ -32,7 +81,7 @@ and this project adheres to
 
 <csr-read-only-do-not-edit/>
 
- - 6 commits contributed to the release over the course of 13 calendar days.
+ - 7 commits contributed to the release over the course of 13 calendar days.
  - 13 days passed between releases.
  - 6 commits were understood as [conventional](https://www.conventionalcommits.org).
  - 0 issues like '(#ID)' were seen in commit messages
@@ -44,6 +93,7 @@ and this project adheres to
 <details><summary>view details</summary>
 
  * **Uncategorized**
+    - Release dagger-core v0.2.8, dagger-sdk v0.2.16 ([`f390eac`](https://github.com/kjuulh/dagger-rs/commit/f390eac29f1d041d18d2207a5aa0a8d993aab68c))
     - fix tasks ([`e642778`](https://github.com/kjuulh/dagger-rs/commit/e642778d9028726dfb07217814e15ad1dd3b83f2))
     - with dagger-engine v.0.4.0 ([`7133bfa`](https://github.com/kjuulh/dagger-rs/commit/7133bfae9508bc5977548e373c49342a1248d6e4))
     - fix missing await in connect ([`13b7805`](https://github.com/kjuulh/dagger-rs/commit/13b7805e7e6fcf47e0a1318adcc25b4ab773a3c9))

crates/dagger-sdk/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "dagger-sdk"
-version = "0.2.16"
+version = "0.2.17"
 edition = "2021"
 readme = "README.md"
 license-file = "LICENSE.MIT"