diff --git a/README.md b/README.md index 9ba7ffd..23f5e72 100644 --- a/README.md +++ b/README.md @@ -2,29 +2,23 @@ This project is a Nuxt 3 application for serving documentation for various tools in the gptscript ecosystem. -## Setup +## Local development To get started locally, follow these steps: 1. Clone this repository: - ```bash - git clone https://github.com/gptscript-ai/pkg-gptscript.git - ``` +```bash +git clone https://github.com/gptscript-ai/pkg-gptscript.git +``` -2. Install the dependencies: +2. Create a .env file in the root of your project and add your GitHub token: - ```bash - yarn install - ``` +```bash +GITHUB_TOKEN=your_github_token +``` -3. Create a .env file in the root of your project and add your GitHub token: +3. Start the development environment: - ```bash - GITHUB_TOKEN=your_github_token - ``` - -4. Start the development server: - - ```bash - yarn dev - ``` \ No newline at end of file +```bash +yarn local +```