Merge pull request #37 from EvanNelson04/master

Readme

.mdlrc

@@ -0,0 +1 @@
+rules "~MD013, ~MD033"

README.md

@@ -1,4 +1,12 @@
-# cellveyor
+<img src="https://github.com/GatorEducator/cellveyor/blob/master/.github/images/cellveyor-logo.svg" alt="Cellveyor Logo"
+    title="Cellveyor Logo" />
+
+# 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
 
@@ -20,3 +28,44 @@ developer-development/feedback-overall-course-assessment.yml \
 --github-repository-prefix computer-science-203-fall-2023-course-assessment \
 --transfer-report
 ```
+
+## 🎉 Introduction
+
+- Cellveyor is a python program that produces assignment reports for students or
+classes. Using Cellveyor will publicly give grade reports including feedback for
+created assignments. Using the Cellveyor tool will quickly run and send reports to
+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.
+
+## 😂 Definitons
+
+- Cellveyor is a tool that automatically produces a report based output by
+analyzing a 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
+
+- 🚀 Fully customizable command line interface
+- ✨ Automated generation of grade-based reports sent to students
+- 🪂 Rich command line interface with many various arguments
+
+## ⚡️ Requirements
+
+- Cellveyor git hub repository
+- Local google sheet
+- Git hub token
+
+## 🔽 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