Merge pull request #20 from ejunga/beta

Bring beta branch up-to-date

README.md

@@ -0,0 +1,51 @@
+
+# TDX Userscript
+## Features
+ - Dark mode
+	 - Follows system scheme by default, can be overridden
+ - Custom themes & styling
+ - Open links in new tabs
+ - Use native browser calendar pickers
+	 - Added modifiers for quick date manipulation
+ - 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 from the Settings menu
+ - Use the Editor popout for greater customization
+	 - The generated code can be shared among other users
+
+## Custom Layouts
+- 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:
+	 - Report name follows this format:
+		 - `{"name":"Clock","url":"https://tinyurl.com/bdh7sduu"}`
+		 - There is a character limit where a link shortener may help
+	- To satisfy the report, a column must exist:
+		- **Columns & Filters**
+			- `Age`
+	    - **Filters**
+		    - `Age` equals `-1`