From eac73ada69ad50f72ddada6afbe5902df9c092d1 Mon Sep 17 00:00:00 2001 From: David Allen Date: Sun, 31 Aug 2025 21:59:14 -0600 Subject: [PATCH] chore: removed TODO and update plugin struct --- README.md | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 916cd52..380d435 100644 --- a/README.md +++ b/README.md @@ -207,14 +207,12 @@ On the other hand, profiles are simply objects that contain data used to populat type Profile struct { ID string `json:"id"` // profile ID Description string `json:"description,omitempty"` // profile description - Tags []string `json:"tags,omitempty"` // tags used for ... - Paths []string `json:"paths,omitempty"` // paths to download - Plugins []string `json:"plugins,omitempty"` // plugins to run + Tags []string `json:"tags,omitempty"` // tags used for filtering (not implemented yet) Data map[string]any `json:"data,omitempty"` // include render data } ``` -Profiles can be created using JSON. See the example in `$MAKESHIFT_ROOT/profiles/default.json`. +Profiles can be created using JSON and only require an `id` with optional `data`. See the example in `$MAKESHIFT_ROOT/profiles/default.json`. ```json { @@ -235,12 +233,9 @@ Profiles can be created using JSON. See the example in `$MAKESHIFT_ROOT/profiles There are some features still missing that will be added later. -1. Uploading files and directories -2. Uploading new profiles and plugins -3. Running `makeshift` locally with profiles and plugins -4. Plugin to add user data for one-time use without creating a profile -5. Optionally build plugins directly into the main driver -6. Protected routes that require authentication -7. Configuration file for persistent runs -8. `Dockerfile` and `docker-compose.yml` files to build containers -9. Including certs with requests \ No newline at end of file +1. Running `makeshift` locally with profiles and plugins +2. Plugin to add user data for one-time use without creating a profile +3. Optionally build plugins directly into the main driver +4. Protected routes that require authentication +5. Configuration file for persistent runs +6. `Dockerfile` and `docker-compose.yml` files to build containers \ No newline at end of file