Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Raphico committed May 3, 2024
1 parent f68c8b7 commit bfb4d3f
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
# Byte
# [Byte](https://byte-liart.vercel.app)

A platform for developers to plan and manage virtual workshops

## Core features

1. Users should be able to create and schedule virtual workshops, specifying details such as title, details, date, time, duration, and target audience

2. Users should be able to register for workshops, receiving confirmation for registering and receiving reminders for upcoming events

3. Interactive workshop session with video conferencing for organizer, live chats for participants to communicate with other participants and the organizer, and an integrated code editor for participants to follow along

## Tech stack

- **Frontend:** Typescript, [Next.js](https://nextjs.org/), [Tailwindcss](https://tailwindcss.com)
Expand All @@ -17,8 +25,9 @@ The architecture of this project revolves around a streamlined development and d
## Roadmap

- [x] Deploy the application to Vercel
- [ ] App setup
- [ ] Setup home page
- [ ] Add auth with clerk
- [ ] Add auth
and more

## Running locally
Expand Down

0 comments on commit bfb4d3f

Please sign in to comment.