From: Aidan Cornelius-Bell <aidan@cornelius-bell.com>
Date: Sat, 2 Nov 2024 03:35:37 +0000 (+1030)
Subject: Update readme
X-Git-Url: https://gitweb.mndrdr.org/?a=commitdiff_plain;h=0c4d4ff821537d7ccdb60f7c13619f3b24c6c81a;p=arelpe.git

Update readme
---

diff --git a/README.md b/README.md
index 3929494..0ac9860 100644
--- a/README.md
+++ b/README.md
@@ -38,16 +38,16 @@ Arelpe is a Ruby on Rails application that provides a RESTful API for managing b
    ```
 
 4. Set up encryption
-  ```
-  rails db:encryption:init
-  EDITOR="nano" rails credentials:edit
-  ```  
+   ```
+   rails db:encryption:init
+   EDITOR="nano" rails credentials:edit
+   ```  
 
 5. Set up TOTP codes (maybe needed in PROD)
-  ```
-  rails generate migration AddConsumedTimestepToUsers consumed_timestep:integer
-  RAILS_ENV=production rails db:migrate
-  ```
+   ```
+   rails generate migration AddConsumedTimestepToUsers consumed_timestep:integer
+   RAILS_ENV=production rails db:migrate
+   ```
 
 
 5. Start the Rails server:
@@ -55,6 +55,31 @@ Arelpe is a Ruby on Rails application that provides a RESTful API for managing b
    rails server
    ```
 
+## Required Environmentals
+
+You'll need some configuration of the following:
+
+```
+MYSQL_SOCKET=
+MYSQL_PASSWORD=
+MYSQL_USERNAME=
+MYSQL_HOST=
+RAILS_ENV=
+SECRET_KEY_BASE=
+SMTP_ADDRESS=
+SMTP_PORT=
+SMTP_USERNAME=
+SMTP_PASSWORD=
+HCAPTCHA_SITE_KEY=
+HCAPTCHA_SECRET_KEY=
+BUTTONDOWN_API_KEY=
+STRIPE_PUBLISHABLE_KEY=
+STRIPE_SECRET_KEY=
+ADMIN_EMAIL=
+OTP_SECRET_KEY=
+RAILS_MASTER_KEY=
+```
+
 ## API Usage
 
 Please refer to the [API Documentation](API_DOCUMENTATION.md) for detailed information on how to use the API.