diff --git a/README.md b/README.md index 128815d..9e3fefb 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,43 @@ Some good business reasons why using AutomataCI: ## How-tos, Documentations & Specifications -TBD + +To use HiAI, you need to first setup 1-time `CONFIG.toml` file: + +``` +# in POSIX Shell +$ ./hiAI.sh.ps1 --create-config path/to/file.toml + +# in Powershell +$ powershell.exe -noprofile -executionpolicy bypass ` + -Command "& .\hiAI.sh.ps1 --create-config 'path\to\file.toml'" + + +# update the path/to/file.toml especially with the API token. +``` + +Once done, you may proceed to execute it: + +``` +# POSIX Shell +$ hiAI.sh.ps1 --config path/to/file.toml --text2text "...your prompt..." + + +# PowerShell +$ powershell.exe -noprofile -executionpolicy bypass ` + -Command "& .\hiAI.sh.ps1 --config path\to\file.toml --text2text `"...your prompt...`"" +``` + +In any cases, if you need an on-screen assistances: +``` +# POSIX Shell +$ hiAI.sh.ps1 --help + + +# PowerShell +$ powershell.exe -noprofile -executionpolicy bypass ` + -Command "& .\hiAI.sh.ps1 --help" +```