From afc7db53e195bfe53d6de8f2f786fefba6a606d3 Mon Sep 17 00:00:00 2001 From: David Allen Date: Sun, 31 Aug 2025 00:20:23 -0600 Subject: [PATCH] chore: updated README with upload examples --- README.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7bcfc54..c30b134 100644 --- a/README.md +++ b/README.md @@ -92,9 +92,30 @@ makeshift download profile default (WIP) Files, directories, profiles, and plugins will eventually be able to be uploaded to the server. ```bash -# upload a file or directory (recursively) -makeshift upload -makeshift upload --host http://localhost:5050 --path help.txt +# upload a single file in root directory + makeshift upload -d @compute-base.yaml + + # upload a directory (not working yet...) + makeshift upload -d @setup/ + + # upload an archive (extracted and saved on server - not working yet...) + makeshift upload -d @setup.tar.gz -t archive + + # upload a new profile with a specific path (used to set remote location) + makeshift upload profile -d @kubernetes.json -p nodes/kubernetes.json + makeshift upload profile -d @slurm.json -@compute.json -p nodes + + # upload a new profile + makeshift upload profile -d @compute.json + + # upload a new profile with a specific path (used for lookup) + makeshift upload profile -d @kubernetes.json -n k8s + + # upload a new plugin + makeshift upload plugin -d @slurm.so + + # upload a new plugin with a specific name (used for lookups) + makeshift upload plugin -d @cobbler.so -n merge ``` > [!NOTE]