diff --git a/README.md b/README.md deleted file mode 120000 index b5aff48..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -crates/dagger-sdk/README.md \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..772362a --- /dev/null +++ b/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