Thunderstore
Thunderstore copied to clipboard
Expose README on package detail API
While it makes sense to not have the readme when getting all packages, it does make sense to have the readme when querying for a specific mod. As it stands, most mods have next to no info in their description as the site doesn't show it predominantly
Tl;DR /package/:uuid4
should have the readme
field added back in while /package/
should keep current behavior.
I agree that there should be more info available, but I'm still undecided if the entire readme is what we're really after.
There's at least a few things to consider with that approach, such as:
- differences on formatting between view locations
- useless or too much info (e.g. install instructions when those are not needed)
It is of course easier for mod creators to jus have to define a single long readme, instead of some multiple ones.
I think what we really want to show is some kind of a showcase of the mod, which can contain a list of features / other media (such as gifs, pictures, or vide). Naturally instructions as well.
I don't really know just yet what would be the best long term approach, but just adding the readme back would definitely be the easiest way
I think at least until a more standardized solution can be made, adding the readme back to the /package/:uuid4
route would be really useful.
Currently my mod manager can only provide the (usually one line) description without downloading the whole mod just for the readme, which obviously isn't something we want to be doing.