From 7bb2b118a6faa142e1438cf74b320301c08c9c74 Mon Sep 17 00:00:00 2001 From: "Martin, Alexander Scott" Date: Wed, 5 Feb 2025 14:57:24 -0500 Subject: [PATCH] Update README.md --- README.md | 35 +++++++++++++++++++++++++++++++---- 1 file changed, 31 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 94ec9ad..286f756 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,45 @@ + # TDX Userscript ## Features - Dark mode + - Follows system scheme by default, can be overridden - Custom themes & styling - Open links in new tabs (or windows) - Use native browser calendar pickers - Added modifiers for quick date manipulation - - Shortcuts to Purdue IT [Status](https://it.purdue.edu/status/) & [TDX Tools](https://engineering.purdue.edu/ecnuds/tdx/) + - Shortcuts to Purdue IT Status & TDX Tools linked in the header + - Hover over the Status button to view the current status, or click the button to open the page - Add embedded websites as desktop panels (instructions below) - Custom layouts +## Installation + - Download & install Tampermonkey + - Install the Userscript: + - Open the Tampermonkey dashboard + - Open the Utilities tab + - Paste this link into **Import from URL** + - `https://raw.github.itap.purdue.edu/ECN/tdx-userscript/main/tdx-enhanced.js` + - Click install + - If using Chrome: Enable developer mode + - Visit chrome://extensions + - Toggle **Developer mode** in the top-right corner + - Restart Chrome + +## Usage + - Open TDNext + - Click the wrench icon in the top-right corner to access the settings menu + - Some settings will require the page to be refreshed before changes take effect + ## Custom Styling - - Change accent and background color - - Use the Editor for greater customization - - The generated code can be shared among other users + - Change accent and background color from the Settings menu + - Use the Editor popout for greater customization + - The generated code can be shared among other users + +## Custom Layouts + - Currently only one layout supported: + - When using the **100% / 50-50%** layout, a custom layout can modify the two bottom columns for 66-33% width (100% / 66-33%) + - Sticky Columns: + - When using a layout where one column may be shorter than the other, it can be pinned to the top while the other column continues scrolling ## Embedded Websites - A website can be embedded by creating a dummy Report with the following contents, adding it to your Desktop: