From 81a8499d2b60035f47a731d7900486fb3b54261e Mon Sep 17 00:00:00 2001
From: Reese Armstrong <me@reeseric.ci>
Date: Wed, 9 Aug 2023 15:39:29 -0500
Subject: [PATCH] Initial README

---
 README.md | 48 ++++++++++++++++++++----------------------------
 1 file changed, 20 insertions(+), 28 deletions(-)

diff --git a/README.md b/README.md
index 6b8d31d..95a9fc3 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,20 @@
-# README
-
-This README would normally document whatever steps are necessary to get the
-application up and running.
-
-Things you may want to cover:
-
-* Ruby version
-
-* System dependencies
-
-* Configuration
-
-* Database creation
-
-* Database initialization
-
-* How to run the test suite
-
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...
-
-## Development
-
-For hot reload functionality, make sure to have Redis installed.
\ No newline at end of file
+# Obl.ong
+
+This is the backbone for Obl.ong, a nonprofit service providing free, quality domains for all. You can run this on your infrastructure if you're looking to manage subdomains or an internal TLD.
+
+## Building
+
+- Install Ruby **3.1.2**
+- Install Ruby on Rails with Bundler
+- Pull submodules
+- Run `rails credentials:edit` and add these keys:
+  ```
+  dnsimple:
+    access_token: DNSIMPLE_ACCESS_TOKEN
+    account_id: ACCOUNT_ID
+
+  postmark_api_token: "POSTMARK_API_TOKEN"
+  ```
+- Run `rails tailwindcss:build`
+- Edit `config/application.rb` to reflect your environment
+- Start the server with `bin/rails server`