diff --git a/README.md b/README.md index 9ea9eef..2236ed4 100644 --- a/README.md +++ b/README.md @@ -17,16 +17,19 @@ This project is a Solana-based meme generator that allows users to connect their ## Setup - Install dependencies: + ```sh npm install ``` - Copy the `.env.example` file to `.env.local` and add your API keys: + ```sh cp .env.example .env.local ``` - Add your FAL AI key to the `.env.local` file: + ```env # Get key from https://fal.ai/ FAL_AI_KEY=your_fal_ai_key @@ -34,7 +37,7 @@ This project is a Solana-based meme generator that allows users to connect their - Setup a project on - - Visit https://app.pinata.cloud/developers/api-keys and click the `New Key` button to create a new key + - Visit and click the `New Key` button to create a new key - Choose the `Admin` scope and create the API key @@ -53,6 +56,7 @@ This project is a Solana-based meme generator that allows users to connect their ``` - Run the development server: + ```sh npm run dev ``` @@ -64,3 +68,7 @@ This project is a Solana-based meme generator that allows users to connect their - Connect your Solflare or Phantom wallet using the "Connect Wallet" button. - Select an AI model and enter a prompt to generate a meme. - Pay the required MTM tokens and wait for the meme to be generated. + +## Deploy + +Follow [instructions](./deploy/README.md) for deploying `sol-mem-gen` and `sol-token-locker`