Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mart2070 authored Feb 5, 2025
1 parent 8eeebcc commit 7bb2b11
Showing 1 changed file with 31 additions and 4 deletions.
35 changes: 31 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <a href="https://it.purdue.edu/status" target="_blank">Purdue IT Status</a> & <a href="https://engineering.purdue.edu/ecnuds/tdx" target="_blank">TDX Tools</a> 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 <a href="https://www.tampermonkey.net/index.php" target="_blank">Tampermonkey</a>
- 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 <a href="chrome://extensions" target="_blank">chrome://extensions</a>
- 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:
Expand Down

0 comments on commit 7bb2b11

Please sign in to comment.