GitHub documentation (#79)

Author: ghidalgo3

CHANGELOG.md

@@ -9,10 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Public documentation.
 - User custom lists feature: users can now create, manage, and delete their own named recipe lists
 - Tests!
 
 ### Changed
 
+- Made the repository public.
 - Made authentication cookie persist for longer, helps mobile Safari
 - Reorganized the source code so it's all under `src`

README.md

@@ -3,9 +3,9 @@
 CookTime is a recipe management system!
 It is composed of:
 
-1. REST API
-1. Browser application
-1. PostgreSQL schemas and functions for storing and querying recipes
+1. REST API (C# ASP.NET app in `src/CookTime`)
+1. Browser application (React SPA in `src/CookTime/client-app`)
+1. PostgreSQL schemas and functions for storing and querying recipes (SQL statements in `src/CookTime/Scripts`)
 
 With CookTime you can do things like:
 
@@ -15,16 +15,54 @@ With CookTime you can do things like:
 1. Compute a recipe's nutrition facts
 1. Track grocery lists of ingredients to make sets of recipes
 
+## Features
+
+### Recipe Index
+
+Search by whatever you want!
+
+![CookTime homepage](docs/media/cooktime_homepage_2026_02_01.png)
+
+### Grocery Lists
+
+Aggregate ingredients into one grocery list!
+
+![CookTime grocery list](docs/media/cooktime_groceries_2026_02_01.png)
+
+### Nutrition Facts
+
+Automatically computed nutrition facts using USDA nutrition data!
+
+![Recipe nutrition facts](docs/media/cooktime_nutrition_2026_02_01.png)
+
+### Recipe scaling
+
+Scale recipes to make more or less servings!
+
+![Recipe scaling and highlighted ingredients](docs/media/cooktime_recipe_instructions_2026_02_01.png)
+
+### Recipe lists
+
+Come up with your own recipe lists, and share them with the world!
+
+![Cooktime lists](docs/media/cooktime_lists_2026_02_01.png)
+
+### Social sign on
+
+No more username and passwords!
+
+![Sign in with Google](docs/media/cooktime_signin_2026_02_01.png)
+
 ## Getting started
 
 Assuming [Docker Desktop][Docker Desktop] installed on Linux or macOS,
-use the `scripts` directory contents to get started from in /babe-algorithms:
+use the `scripts` directory (found at the root of the repo) contents to get started:
 
 ```shell
 scripts/server
 ```
 
-Then open <http://localhost:3000> to get started!
+Then open <http://localhost:3000> in a browser!
 
 I recommend using VSCode to develop CookTime, for that you will need to install: