docs: update readme.md

README.md

@@ -1,48 +1,3 @@
-# Next.js App
+# Election Mark Generator
 
-This is project was bootstrapped with [betich's](https://github.com/betich/next-boilerplate) Next.js boilerplate template.
-
-## Instructions
-
-Below are ways to start your project with this boilerplate.
-
-1. Use `degit` to clone the repo
-
-```bash
-npx degit betich/next-boilerplate your-app-name
-cd your-app-name
-git branch -m master main
-npm i
-```
-
-2. Clone the repo with git
-
-```bash
-git clone https://github.com/betich/next-boilerplate your-app-name
-cd your-app-name
-npm i
-```
-
-## Features
-
-1. Typescript alias paths
-
-```ts
-import { Header } from "@/components/Main"
-import { User } from "@/types"
-```
-
-We've added alias paths for the `src` directory. Example:
-
-- `src/components` => `@/components`
-- `src/styles` => `@/styles`
-- `src/elements` => `@/elements`
-- `src/utils` => `@/utils`
-
-2. Prettier
-
-Customize how prettier works by editing the `.prettierrc` file.
-
-3. ESLint
-
-Customize how eslint works by editing the `.eslintrc.js` file.
+Generates election marks to be processed in a machine learning algorithm. We are trying to create an image classifying algorithm to validate good/bad ballot's for our election simulator project.