From 2fc7257929982aaf2d08a028ffae691fdcc3f14d Mon Sep 17 00:00:00 2001 From: Liam Date: Wed, 22 Nov 2023 15:37:50 +0000 Subject: [PATCH] update readme --- README.md | 42 ++++++++++-------------------------------- 1 file changed, 10 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index c403366..9e8bc8b 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,14 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +# Scoresaber PP to Rank Overlay -## Getting Started +Nothing fancy, just made this for me and a friend but feel free to use it.
+The text is white, so it you won't be able to see it. It will show up on OBS though. -First, run the development server: +## Usage -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` +Usage:
+Example: + -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. - -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. - -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! - -## Deploy on Vercel - -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +- ID: Your scoresaber ID +- Rank: The rank you want to get to +- Started: The time you started the song in miliseconds. You can get this at