From 92a74081005d25343e805dc805ac7a801c3489a4 Mon Sep 17 00:00:00 2001 From: Adrian Bonpin Date: Wed, 19 Aug 2026 03:06:57 +0800 Subject: [PATCH] docs: move Install section to top of README --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 71b0e60..2fdd1e2 100644 --- a/README.md +++ b/README.md @@ -10,17 +10,6 @@ extension for the USC ISMIS student portal that: One codebase builds for **both browsers** (see [Build](#build)). -## Features - -- **Saved login profiles** (stored in `browser.storage.local`) — only one enabled at - a time, with a master on/off toggle. -- **One-click Download PDF** button on the Study Load page. -- PDF settings in the popup: - - Truncate long course descriptions to match the official PDF (default on). - - Show/hide `Year Level`, and set a custom Year Level value. -- **Bundled Segoe UI fonts** for a 1:1 look with the official document. -- Builds and packages automatically via Gitea Actions (zips + versioned releases). - ## Install > Temporary/development install. For distribution, publish the built zips to @@ -54,9 +43,9 @@ One codebase builds for **both browsers** (see [Build](#build)). > For a persistent install, package and publish via Firefox AMO / Chrome Web Store > with the same built zips. -## Distribute to real users +### Distribute to real users -### Firefox (self-hosted, temporary) +#### Firefox (self-hosted, temporary) > **Note:** Firefox blocks unsigned extensions for normal installs. The proper > fix is to sign the add-on via **addons.mozilla.org (AMO)** and publish it there @@ -79,7 +68,7 @@ One codebase builds for **both browsers** (see [Build](#build)). > (or sign it with `web-ext sign`) so users install it normally without touching > `about:config`. -### Chrome (self-hosted) +#### Chrome (self-hosted) Chrome does **not** require signing for normal installs. Users can install the built `ismis-helper-chrome.zip` directly: @@ -91,6 +80,17 @@ built `ismis-helper-chrome.zip` directly: > For a store experience, publish the same zip to the Chrome Web Store (one-time > $5 developer registration). +## Features + +- **Saved login profiles** (stored in `browser.storage.local`) — only one enabled at + a time, with a master on/off toggle. +- **One-click Download PDF** button on the Study Load page. +- PDF settings in the popup: + - Truncate long course descriptions to match the official PDF (default on). + - Show/hide `Year Level`, and set a custom Year Level value. +- **Bundled Segoe UI fonts** for a 1:1 look with the official document. +- Builds and packages automatically via Gitea Actions (zips + versioned releases). + ## Build Requires **Node.js** (the `build.js` script itself is dependency-free; `npm install`