From 4e0b328e0761e668fa65cf663aa704b34a1d34cf Mon Sep 17 00:00:00 2001
From: EvanNelson04 <nelson01@allegheny.edu>
Date: Tue, 5 Dec 2023 11:53:35 -0500
Subject: [PATCH] readme update

---
 README.md | 33 +++++++++++++++++++++------------
 1 file changed, 21 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 8116dcf..c295c2b 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,9 @@
-# cellveyor
+# Cellveyor
+
+[![build](https://github.com/GatorEducator/cellveyor/actions/workflows/build.yml/badge.svg)](https://github.com/GatorEducator/cellveyor/actions/workflows/build.yml)
+[![Code Style: black](https://img.shields.io/badge/Code%20Style-Black-blue.svg)](https://github.com/psf/black)
+[![Maintenance](https://img.shields.io/badge/Maintained%3F-Yes-blue.svg)](https://github.com/gkapfham/chasten/graphs/commit-activity)
+[![License LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
 
 ## Example Command
 
@@ -21,7 +26,7 @@ developer-development/feedback-overall-course-assessment.yml \
 --transfer-report
 ```
 
-🎉 Introduction
+## 🎉 Introduction
 
 - Cellveyor is a python program that produces assignment reports for students or
 classes. Using cellveyor will publicly give grade reports including feedback for
@@ -30,25 +35,29 @@ members included in a locally created google spreadsheet. By running the command
 created, this will quickly and automatically send out these reports in a very timely
 and efficient fashion.
 
- 😂 Definitions
+## 😂 Definitions
 - Cellveyor (uncountable or singular noun) "a tool that automatically produces a report based output by analyzing a
-google sheet"
-    - Student sentence:
-    - Instructor sentence: "cellveyor makes it much easier for me to tell my students what their grade looks like
-    on a certain assignment"
+Google sheet"
+    - Student sentence: "I'm glad cellveyor made it easy for me to see my grades from my classes, it's so easy
+    to read and analyze."
+    - Instructor sentence: "Cellveyor makes it much easier for me to tell my students what their grade looks like
+    on a certain assignment or overall in the class"
     - Researchers sentence: "I found that cellveyor is a very interesting tool that quickly and automatically does
     a task that is necessary in schooling"
 
- 🔋Features
+## 🔋Features
+- 🚀 Fully customizable command line interface
+- ✨ Automated generation of grade-based reports sent to students
+- 🪂 Rich command line interface with many various arguments
 
- ⚡️ Requirements
+## ⚡️ Requirements
 - Cellveyor git hub repository
 - Local google sheet
 - Git hub token
 
- 🔽 Installation
+## 🔽 Installation
 Follow these steps to install the cellveyor program:
 1. Copy the ssh key of the repo
 2. ```Git clone``` the repository onto your personal computer
-- ```git clone (ssh key)``
-3. type ```poetry run cellveyor --help``` to learn how to use the tool
+    - ```git clone (ssh key)```
+3. Type ```poetry run cellveyor --help``` to learn how to use the tool