From aa107f802816b2d89f38533f33473eb317292517 Mon Sep 17 00:00:00 2001 From: kjuulh Date: Sun, 29 Jan 2023 22:33:21 +0100 Subject: [PATCH] add architecture --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index ecb0c78..a3d2238 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,16 @@ Work in progress. This is not ready for usage yet - [ ] Implement context and querier - [ ] fix build / release cycle - [ ] general api stabilisation + +## 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.