From 7dff45ec93377a2b905d93940604677772d0f170 Mon Sep 17 00:00:00 2001 From: Adam T <59237731+AdamPSU@users.noreply.github.com> Date: Sat, 4 Nov 2023 13:07:57 -0400 Subject: [PATCH] Finalize README.md --- README.md | 40 +++++++++++++++++++--------------------- 1 file changed, 19 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index a8b9964..52fefff 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,31 @@
Overview • - Requirements + Features • - License + Example
# Overview -BytePSU Bot (temporary name) is a Discord bot that automates the process of finding new internships for college students, without the need of any input. The Discord bot notifies when a new internship has been posted, with details regarding when it was posted, salary, requirements, and other information. - -The bot currently only uses [levels.fyi's](https://levels.fyi/internships) internship lisitngs in order to fetch new internships. Later down the road, we will use multiple websites that will allow us to gather more internships. - -Keep in mind that the bot is currently under heavy development. - -This is the first collaborative project from BytePSU club. -# Requirements -This Discord uses [Python 3.11](python.org) and [discord.py](https://discordpy.readthedocs.io/en/stable/). - -A requirements.txt is included to download all of the packages in mass. - -You will also need an Application through the Discord Development Portal in order to run the bot. - -# License -This repo is under the [MIT license](https://github.com/BytePSU/discord-bot/blob/main/LICENSE). - +Our Discord bot automates the process of finding new internships for college students. When a new internship entry is entered on [levels.fyi's](https://levels.fyi/internships) job board, a signal is sent to our bot to notify users of the new position. All necessary information is neatly packaged into one embedded message, with details regarding: + +- Salary +- Education Requirements +- Location +- And more + +This is the first collaborative project from BytePSU club; expect more updates to come as we revisit this project in due time. +# Features +- Easy to use +- Fast, real-time updates +- Find positions at random +- Find positions from a specified index +# Example +![Loading Image...](https://imgur.com/05fcK3Z.gif)