Prompt users to open Readme on developer's request

[kyrie25]

📝 Provide a description of the new feature

There are currently themes and extensions that has this issue (eg. Dribbblish Dynamic) where the users are required to install the theme/extension locally or to take extra steps before installing, and that Marketplace installation doesn't work properly for them.

In order for theme/extension developers to not feel discouraged from publishing to Marketplace, I'd suggest making an additional field on the manifest format that requests Marketplace to open its Readme and read the requirements before installing (boolean value).

➕ Additional Information

Currently I can think of a few ways to do this:

• For the specified theme/extension, replace the Install button on Cards to the GitHub icon, on click it would prompt the user with a modal which would open the Readme externally (on their browser etc.).

This means that users will have to install said theme/extension via the CLI.

• We could also use the GitHub icon but open the Readme inside Marketplace itself, with a notification shown that tells the user to read the Readme beforehand and then they can install the theme/extension using the button inside the Readme page.

This means that users can still install said theme/extension via Marketplace, and the extension/theme devs can include whether it should be installed Marketplace or not.

[CharlieS1103]

@kyrie25 Rather than having it open up the entire readme, could we instead allow the extension/theme owners to open any .MD file in the repo to allow more room for customization, we can simply have an optional parameter in the manifest titled "special-instructions" or "force-open" or something of the like.

[kyrie25]

The general idea is that it prevents themes/extensions breaking from installing on Marketplace so yeah whichever works.

[theRealPadster]

What doesn't work when installed via marketplace? Themes have the "include" array to bundle extensions in them.

[kyrie25]

What doesn't work when installed via marketplace? Themes have the "include" array to bundle extensions in them.

Stuff like Dribs, Dribs Dynamic & Default not working properly since it requires libraries to be loaded early or requires extra patching in config-xpui, etc.
Would be nice for extensions that wants to use custom hooks also.

[theRealPadster]

Ah, right, didn't think of that. I think it's probably easier to support just having it open externally and make them install via cli. Otherwise you'll have people with weird hybrids