diff --git a/README.md b/README.md index 4d8ffdb..a76b8d5 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,12 @@ A npm package that uses OpenAI + Langchain to perform convenient commands in the ## Get Started +Ensure that typescript is installed globally `npm install -g typescript`. + To get started with the project clone the repository and run `npm i & npm run build && npm install -g .` within the project root. +(Mac or Linux users may have to run `sudo` before some of these commands. + Calling the `gptcli` command from the command-line will run the CLI. For updates simply run `git pull & npm i & npm run build` within the project root.