From f5eb154299b6f832073f76d4514eade11b7a62e8 Mon Sep 17 00:00:00 2001
From: Nabarun <nabarun@deepstacksoft.com>
Date: Mon, 27 Jan 2025 15:28:55 +0530
Subject: [PATCH] Add readme with setup steps

---
 .gitignore |  4 ++++
 README.md  | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 50 insertions(+)
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
index 42fc8c0..28028d2 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,7 @@ node_modules
 .next
 
 .env
+.env.local
+.env.development
+.env.production
+.env.test
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6e1b9a9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# sol-mem-gen
+
+This project is a Solana-based meme generator that allows users to connect their wallets, pay with MTM tokens, and generate memes using AI models.
+
+## Features
+
+- Connect to Solflare and Phantom wallets
+- Pay with MTM tokens
+- Generate memes using various AI models
+
+## Prerequisites
+
+- Node.js
+- npm
+- Solflare or Phantom wallet
+
+## Setup
+
+1. Install dependencies:
+    ```sh
+    npm install
+    ```
+
+2. Copy the `.env.example` file to `.env.local` and add your FAL AI key:
+    ```sh
+    cp .env.example .env.local
+    ```
+
+3. Add your FAL AI key to the `.env.local` file:
+    ```env
+    # Get key from https://fal.ai/
+    FAL_AI_KEY=your_fal_ai_key
+    ```
+
+4. Run the development server:
+    ```sh
+    npm run dev
+    ```
+
+5. Open your browser and navigate to `http://localhost:3000`.
+
+## Usage
+
+1. Connect your Solflare or Phantom wallet using the "Connect Wallet" button.
+2. Select an AI model and enter a prompt to generate a meme.
+3. Pay the required MTM tokens and wait for the meme to be generated.
-- 
2.45.2