Start customization instructions

README.md

@@ -1,12 +1,13 @@
-# Wedding with Rails
+# Rails App for Weddings and Events
 
 This is a simple rails app for managing the guest list for a wedding (or similar event). It's intended to be easy to customize.
 
 ## Features
 
 - Guests can RSVP, including dietary requirements and plus ones
-- Sends guests a confirmation email they can use to manage their RSVP
-- Responsive design
+- Guests can manage their own RSVPs using a secret link in an email (no user name / password needed)
+- Responsive design on home page and RSVP pages
+- Customizable [styling and wording](#Customization)
 - [Active Admin](https://activeadmin.info/) interface to manage the attendee list
 - Optional invisible [reCAPTCHA](https://www.google.com/recaptcha) integration to avoid spam
 - Sets headers to avoid being indexed by search engines
@@ -18,6 +19,8 @@ This is a simple rails app for managing the guest list for a wedding (or similar
 The simplest way to get started is to use [Docker](https://www.docker.com/).
 
 ```
+git clone https://github.com/jdleesmiller/wedding.git
+cd wedding
 cp development.env.template development.env
 docker-compose build
 docker-compose up -d db
@@ -41,6 +44,8 @@ docker-compose logs -f
 
 By default, the app will run on http://localhost:3000
 
+The admin interface is on http://localhost:3000/admin
+
 To access the database:
 
 ```
@@ -60,6 +65,22 @@ bin/rails console
 bin/rails test
 ```
 
+## Customization
+
+You can of course customize everything, but here are some places to start:
+
+### Content
+
+- [`config/locales/en.yml`](config/locales/en.yml)
+
+  ```yml
+  wedding_name: "Jack & Jill's Wedding"
+  wedding_couple_names: 'Jack & Jill'
+  wedding_date: 'Saturday, 1 January 2000'
+  wedding_location: 'South Pole'
+  photo_credits: 'Photo Credits: Pexels'
+  ```
+
 ## Default photo credits
 
 - https://www.pexels.com/photo/selective-focus-photography-of-two-penguins-689784/