[Documentation] New README for clear information for developers and users

[kevin-wijnen]

Context

The Decky Plugin Store repository currently lacks the documentation for showing which tech has been used, what is necessary to run a self-hosted Decky Loader plugin storefront and pointers where to look for making modifications for those self-hosted storefronts.

The Decky Loader repository has a more comprehensive README which shows the featureset, common issues and installation instructions.

Proposal

My Pull Request tries to close the gap between both repositories regarding documentation in the README file by making the following changes:

• Mentioning more specifics regarding the used tech along with hyperlinks pointing to relevant code or documentation.
• Mentioning the featureset (customisable frontend, endpoints, cloud storage, webhook, package options) for developers to get a clearer view what is currently possible with the storefront code.
• Clear installation instructions for using a custom store with Decky Loader.
• Clear installation instructions how to deploy the project with Docker, including prequesities for self-hosting the store.
• Mentioning possible future changes (PostgreSQL support, third party plugin & repository warnings) noteworthy to developers.
• Stylise it as much as possible with the Decky Loader's README style.

While there are some fields untouched (e.g.: how to customise Decky Store's tag system to add more tags in the plugin browser, rate limiting per plugin), I do hope this will help developers and "self-hosted store hosters" alike to bring more Decky plugin stores to the public.

I'm unable to run a local environment due to the lack of Backblazer environment, so I'd hope some maintainers of the Decky Plugin Store or of any custom store could help out with suggestions and verifying the contents of the README to make it useful for developers.

TODOs

• Stylise it to align more with the Decky Loader README:
  • Screenshot of a custom storefront
  • Statistics buttons
  • Using Steam & Decky Loader button icons for clearer user instructions
• Adding extra relevant developer information (possible suggestions:)
  • Customising plugin store tags
  • Customising certain web pages to distinguish more from the official Decky Loader store channels
  • Common Issues
  • Clearer contribution instructions akin to Decky Loader's README