Skip to content

Commit 2f58ff0

Browse files
committed
feat: Update README.md and CONTRIBUTING.md
1 parent 619839b commit 2f58ff0

File tree

3 files changed

+3
-12
lines changed

3 files changed

+3
-12
lines changed

.env.example

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,8 @@ DATABASE_URL="postgresql://postgres:password@localhost:5432/postgres"
55
BETTER_AUTH_SECRET=your_secret_key # Use `openssl rand -hex 32` to generate
66
BETTER_AUTH_URL=http://localhost:3000
77

8-
# Email Provider (Required)
8+
# Email Provider (Optional)
99
RESEND_API_KEY=your_resend_api_key # Get from https://resend.com
1010

11-
# GitHub OAuth (Optional)
12-
GITHUB_CLIENT_ID=your_github_client_id
13-
GITHUB_CLIENT_SECRET=your_github_client_secret
14-
1511
# App URL (Required)
1612
NEXT_PUBLIC_APP_URL=http://localhost:3000

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ If you prefer not to use Docker:
187187
3. **Set Up Environment:**
188188

189189
- Copy `.env.example` to `.env`
190-
- Configure database connection and other required variables
190+
- Configure database connection and other required authentication variables
191191

192192
4. **Set Up Database:**
193193

README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,7 @@ This will start Sim Studio at http://localhost:3000 with a local PostgreSQL data
3737

3838
3. **[Optional] Configure Your Environment**
3939

40-
Copy `.env.example` to `.env` and configure:
41-
42-
- Authentication secrets (required for login functionality)
43-
- API keys:
44-
- **Essential**: Resend API key (for authentication emails)
45-
- **Optional**: OpenAI, Anthropic, etc. (for specific block functionality)
40+
In `.env`, configure Authentication secrets (required for login functionality) and optionally a Resend API key (for authentication emails).
4641

4742
## Manual Setup
4843

0 commit comments

Comments
 (0)