diff --git a/README.md b/README.md index 009a7427..26516bfd 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@

-🐉 Automate Browser-based workflows with AI 🐉 +🐉 Automate Browser-based workflows using LLMs and Computer Vision 🐉

@@ -36,29 +36,33 @@ This quickstart guide will walk you through getting Skyvern up and running on yo ### Prerequisites Before you begin, make sure you have the following installed: -- [Python 3.11](https://www.python.org/downloads/) +- [Brew (if you're on a Mac)](https://brew.sh/) - [Poetry](https://python-poetry.org/docs/#installation) + - `brew install poetry` +- [Python 3.11](https://www.python.org/downloads/) + - `poetry env use 3.11` - [PostgreSQL 14](https://www.postgresql.org/download/) (if you're on a Mac, setup script will install it for you if you have homebrew installed) + - `brew install postgresql` ### Setup 1. Clone the repository and navigate to the root directory -2. Run the setup script to install the necessary dependencies and setup your environment +1. Run the setup script to install the necessary dependencies and setup your environment ```bash ./setup.sh ``` -3. Create the `.env` file by copying the `.env.example` file and fill in the necessary environment variables +1. Create the `.env` file by copying the `.env.example` file and fill in the necessary environment variables ```bash cp .env.example .env ``` -4. Start the server +1. Start the server ```bash ./run.sh ``` -5. You can start sending requests to the server, but we built a simple UI to help you get started. To start the UI, run the following command: +1. You can start sending requests to the server, but we built a simple UI to help you get started. To start the UI, run the following command: ```bash ./run_streamlit.sh ``` -6. Navigate to `http://localhost:8501` in your browser to start using the UI +1. Navigate to `http://localhost:8501` in your browser to start using the UI ### Additional Setup for Contributors If you're looking to contribute to Skyvern, you'll need to install the pre-commit hooks to ensure code quality and consistency. You can do this by running the following command: @@ -66,11 +70,11 @@ If you're looking to contribute to Skyvern, you'll need to install the pre-commi pre-commit install ``` -## Documentation + ## Frequently Asked Questions (FAQs) ### What gets us excited about Skyvern?