Skip to content

Commit

Permalink
Finalize README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AdamPSU authored Nov 4, 2023
1 parent d1dc5ee commit 7dff45e
Showing 1 changed file with 19 additions and 21 deletions.
40 changes: 19 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,31 @@
<h1 align=center>
<img src="https://i.imgur.com/XiavREx.jpg" width=375>
<br>BytePSU Bot (temporary name)</br>
<br>Internships Bot</br>
</h1>

<h3 align=center>CS Job Application Discord bot facilitated by the PSU community</h3>
<h3 align=center>Job Application facilitated by the PSU community</h3>

<p align="center">
<a href="#overview">Overview</a>
<a href="#requirements">Requirements</a>
<a href="#features">Features</a>
<a href="#license">License</a>
<a href="#example">Example</a>
</p>

# 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)

0 comments on commit 7dff45e

Please sign in to comment.