From d998f8ae49039e992c87b770251204a5bb09e3a4 Mon Sep 17 00:00:00 2001 From: Sean Dickinson Date: Sat, 18 Apr 2026 13:38:44 -0400 Subject: [PATCH] docs: update readme --- README.md | 31 ++++++++++++------------------- 1 file changed, 12 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 7db80e4..806bb1a 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,17 @@ -# README +# EndsideOut LMS -This README would normally document whatever steps are necessary to get the -application up and running. +## Mission -Things you may want to cover: +[EndsideOut](https://endsideout.org/) is a non-profit organization dedicated to combatting obesity and chronic health conditions by building health literacy and fostering behavior change in underserved communities. +They currently run programs in Baltimore, Maryland and some surrounding counties as well as a remote program in Liberia. -* Ruby version +## This Application +This application serves as an LMS tool for EndsideOut to deliver their health literacy curriculum to students and parents in their programs, as well as track statistics and trends. -* System dependencies +## Ruby for Good +EndsideOut is one of many projects initiated and run by Ruby for Good. You can find out more about Ruby for Good at https://rubyforgood.org -* Configuration - -* Database creation - -* Database initialization - -* How to run the test suite - -* Services (job queues, cache servers, search engines, etc.) - -* Deployment instructions - -* ... +## Current Status +This project is currently in active early development and is not yet ready for open source contributors. +We are currently working with the organization to determine exactly what the application needs to do and how it should work. +Once the requirements are more clearly defined, we will be opening the project up for contributions. \ No newline at end of file