From 2bf87193e4a1ebf6d8318eef4ee2ca210f9c539f Mon Sep 17 00:00:00 2001
From: Drew Fout <140226222+dfout@users.noreply.github.com>
Date: Tue, 24 Sep 2024 05:16:11 -0700
Subject: [PATCH] Documentation README.md (#16)

* Documentation README.md

Link to How-to

about message more concise

typo in header

Simplified some directions

Last changes before squashing commits

Squash commits

* contributors .yml action, discord link, license info, and maintainer

* prod changes to github-action-contributors.yml

---------

Co-authored-by: Andrew Adhikari <44456213+t-rhex@users.noreply.github.com>
---
 .../workflows/github-action-contributors.yml  | 35 +++++++
 README.md                                     | 97 ++++++++++++++++++-
 2 files changed, 130 insertions(+), 2 deletions(-)
 create mode 100644 .github/workflows/github-action-contributors.yml

diff --git a/.github/workflows/github-action-contributors.yml b/.github/workflows/github-action-contributors.yml
new file mode 100644
index 0000000..232bdaf
--- /dev/null
+++ b/.github/workflows/github-action-contributors.yml
@@ -0,0 +1,35 @@
+name: Include Contributor
+
+on:
+  pull_request:
+    types: [closed]
+  schedule:
+    - cron: "20 20 * * *" # Run every day at 20:20 UTC
+
+jobs:
+  include-contributor:
+    runs-on: ubuntu-latest
+    environment: Production
+
+    steps:
+      - name: Check DISCORD_PAT
+        env:
+          DISCORD_PAT: ${{ secrets.DISCORD_PAT }}
+        run: |
+          if [ -z "$DISCORD_PAT" ]; then
+            echo "DISCORD_PAT is not set"
+            exit 1
+          fi
+
+      - uses: actions/checkout@v4
+
+      - uses: BobAnkh/add-contributors@master
+        with:
+          CONTRIBUTOR: "### Contributors"
+          COLUMN_PER_ROW: "6"
+          ACCESS_TOKEN: ${{ secrets.DISCORD_PAT }}
+          IMG_WIDTH: "100"
+          FONT_SIZE: "14"
+          PATH: "README.md"
+          COMMIT_MESSAGE: "docs(README): update contributors"
+          AVATAR_SHAPE: "round"
\ No newline at end of file
diff --git a/README.md b/README.md
index abc27e1..fc12356 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,96 @@
-Open Source Church WebApp Template. 
+# Open Source Church WebApp Template
+
+A WebApp template where churches can connect with current and prospective community members. 
+
+Everyone is invited to collaborate. 
+
+## Live Link
+[revival-tan.vercel.app](https://revival-tan.vercel.app/)
+
+## Maintainer
+
+[@t-rhex](https://github.com/t-rhex)
+
+## Contributing
+
+Communications:
+- [Discord Link](https://discord.gg/Q2RcDDq3)
+
+### Fork the Repository 
+1. To fork the repository, click on the **"Fork"** button from the repository main page
+2. Click **"Create New Fork"** page where you select the owner (your personal github account)
+3. Connect your local to the original “upstream” repository by adding it as a remote.
+4. Create a branch for your own edits
+
+### Resolving an Issue
+
+1. Browse Open Issues on the main repository 
+2. Pick an issue you are capable of working on
+3. Work on your forked and updated repo with your feature branch
+4. Submit a PR (Pull Request)
+    - Squash multiple commits into one
+    - Reference any relevant issues or supporting documentation in your PR (for example, “Closes #37.”)
+
+**General Note:** Pull in changes from “upstream” often so that you stay up to date and have less merge conflicts
+
+Refer to the documentation below for more information:
+
+- [How to Contribute to Open Source Projects](https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution)
+## Getting Started
+ Clone the forked repository to your local machine or open in codespaces
+
+Run the development server: 
+```
+cd frontend
+npm install
+npm run build
+```
+```
+npm run dev
+```
+
+or
+
+```
+yarn dev
+# or
+pnpm dev
+# or
+bun dev
+```
+
+Navigate to ```http://localhost:3000``` with your browser to see the site.
+
+**From this Fork, you can now adjust and change the codebase** 
+
+## Deploy on Vercel
+
+The easiest way to deploy this Church Template is to use the [Vercel Platform](https://vercel.com/home). 
+
+## Built With
+- [Next.js](https://nextjs.org/docs)
+- [Tailwind CSS](https://v2.tailwindcss.com/docs/installation)
+- [TypeScript](https://www.typescriptlang.org/docs/handbook/typescript-in-5-minutes.html)
+
+
+
+## License 
+
+[MIT License](https://github.com/t-rhex/OpenSourceChurchTemplate/blob/main/LICENSE) © Andrew Adhikari
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
-Everyone is invited to collaborate.