From 6b43d5bc36693d62324d6f498a90529be68cee95 Mon Sep 17 00:00:00 2001 From: kjuulh Date: Fri, 10 Mar 2023 23:44:36 +0100 Subject: [PATCH] fix: proper readme --- README.md | 41 +---------------------------------------- 1 file changed, 1 insertion(+), 40 deletions(-) mode change 100644 => 120000 README.md diff --git a/README.md b/README.md deleted file mode 100644 index b9de66c..0000000 --- a/README.md +++ /dev/null @@ -1,40 +0,0 @@ -# dagger-rs - -A dagger sdk written in rust for rust. - -# Usage - -See [dagger-sdk](./crates/dagger-sdk/README.md) - -### Status - -- [x] dagger cli downloader -- [x] dagger network session -- [x] graphql rust codegen (User API) - - [x] Scalars - - [x] Enums - - [x] Input - - [x] Objects -- [x] Implement context and querier - - [x] Marshaller - - [x] Querier - - [x] Context - - [x] Deserializer for nested response (bind) -- [x] Add codegen to hook into querier -- [x] fix build / release cycle -- [x] general api stabilisation -- [x] document usage -- [x] make async variant - -## Architecture - -- `.` Root project mainly used for generating the CLI, which in turn is used to - bootstrap the code generation from `dagger` -- `crates/dagger-core` Contains all base types used during actual usage. This is - where the primary logic lives in which the user interacts (\*disclaimer: most - stuff haven't moved in here yet.) -- `crates/dagger-sdk` Contains the actual sdk in which the user interacts, - `dagger-core` is reexported through this API as well. -- `crates/dagger-codegen` This is the bulk of the work, it takes the input - graphql and spits out the API in which the user interacts, this is heavily - inspired by other `dagger-sdk's`. It primarily turns graphql into rust code. diff --git a/README.md b/README.md new file mode 120000 index 0000000..b5aff48 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +crates/dagger-sdk/README.md \ No newline at end of file