Ver código fonte

ref: readmes

Sven 10 meses atrás
pai
commit
97f71d7dcd
4 arquivos alterados com 22 adições e 4 exclusões
  1. 7 1
      src/dev/README.md
  2. 12 0
      src/dev/integrations.md
  3. 1 1
      src/index.ts
  4. 2 2
      src/menu/README.md

+ 7 - 1
src/dev/README.md

@@ -1,2 +1,8 @@
 ## src/dev/
-This directory contains random development files and notes that aren't included in the final build of the userscript.
+This directory contains random development files like notes that aren't included in the final build of the userscript.
+
+<br>
+
+### Contents:
+- [Discoveries I've made about YT and YTM](./discoveries.md)
+- [Integrations with other extensions and tools](./integrations.md)

+ 12 - 0
src/dev/integrations.md

@@ -0,0 +1,12 @@
+## Integrations with other extensions and tools
+BetterYTM integrates with other extensions and tools to provide a smoother experience:
+- (Userscripts)
+  - BYTM has a plugin system that allows users to write their own scripts to extend the functionality of BYTM and benefit from its APIs
+- ReturnYoutubeDislike
+  - BYTM shows the like and dislike counts of songs in YTM
+  - This functionality is also exposed on the interface for plugins to use
+- Enhancer for YouTube
+  - BYTM integrates the set theme in its own UI elements
+- Dark Reader
+  - BYTM disables the extension entirely in YTM because the site doesn't even have a light theme
+  - Dark Reader is disabled for some elements, as it breaks BYTM's precise styling

+ 1 - 1
src/index.ts

@@ -196,7 +196,7 @@ async function onDomLoad() {
         ftInit.push(["playerBarLyricsBtn", addPlayerBarLyricsBtn()]);
     }
 
-    //#region (ytm+yt) cfg menu option
+    //#region (ytm+yt) cfg menu
     try {
       if(domain === "ytm") {
         addSelectorListener("body", "tp-yt-iron-dropdown #contentWrapper ytd-multi-page-menu-renderer #container.menu-container", {

+ 2 - 2
src/menu/README.md

@@ -1,4 +1,4 @@
 ## src/menu/
 This directory contains the code of the now somewhat legacy config menu.  
-It's jankily made to barely work in conjunction with the new BytmDialog instances.  
-To be fully compatible and reduce developer overhead in the long term it will need to be migrated sooner or later, probably as part of a bigger config menu overhaul.
+Its dense and interwoven code has been jankily adapted to just barely work in conjunction with the new BytmDialog instances.  
+To be fully compatible and reduce developer overhead in the long run, sooner or later it will need to be migrated and reworked to be easier to maintain and expand, probably as part of a bigger config menu overhaul.