From 0db0713dc6f562201a06da31f717bdcb889eb6c4 Mon Sep 17 00:00:00 2001 From: Li Yang <76434265+hewliyang@users.noreply.github.com> Date: Fri, 14 Jun 2024 12:00:34 +0800 Subject: [PATCH] chore: update README.md --- README.md | 29 +++++++++++------------------ 1 file changed, 11 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 42a0a11..5d46784 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@

- NUS BetterNextBus Logo + NUS NextBus Web Logo

- BetterNextBus + NUS NextBus Web

-# !DISCLAIMER! -If you have been using this at the `nextbus.me` domain, it has expired and I'm not spending money to renew it. You can continue to use it if you'd like at my personal subdomain at https://bus.hewliyang.com - +> [!WARNING] +> This project is no longer being maintained but should still work as long as the NUS bus API does not radically change. Additionally, the original [nextbus.me](nextbus.me) domain has expired so it's now only accessible via [bus.hewliyang.com](bus.hewliyang.com) +> [!NOTE] > A minimal **PWA** for fetching and displaying NUS Internal Shuttle Bus routes & arrival timings because... too many NUS apps ## Features @@ -16,31 +16,24 @@ If you have been using this at the `nextbus.me` domain, it has expired and I'm n - Reactive Search 📑 - Bookmarking 📒 - Dark Mode 🌑 -- Add to home screen 📱 (**iOS** users do not get the pop-up) - +- Add to home screen 📱 ## Developing -This project uses Bun as the package manager but feel free to delete `bun.lockb` and install -with `pnpm`/`npm`/`yarn`. - Install dependencies ```bash -bun install +pnpm install cp .env.example .env # setup ur config here ``` -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: + +Run the dev server ```bash -bun run dev +pnpm run dev ``` ## Disclaimer -Only shuttle timing data is dynamically fetched, while route & stops are served static under `lib/data/.json` in order to minimise network usage. - -Given this, the data presented including any inaccuracies will be global across all applications. - -By using this service, you agree to abide by the [NUS Acceptable Use Policy for IT Resources](https://nus.edu.sg/registrar/docs/info/registration-guides/aup-form.pdf). +[NUS Acceptable Use Policy for IT Resources](https://nus.edu.sg/registrar/docs/info/registration-guides/aup-form.pdf).