sbordeyne / fastapi_rss

A simple plug-in to FastAPI, that allows easy RSS feed generation.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Missing documentation...

bertmad3400 opened this issue · comments

First of I would just like to add that I love this library. Seemingly, it's the only way to add a simple RSS endpoint to an existing FastAPI instance, and for that I absolutely applaud you as the maintainer(s). With that said though, while the library itself isn't hard to use, I think the biggest thing currently preventing people from actually using it, is the current lacking documentation about how to, and it doesn't even have to be something massive. Providing some code examples on how to implement a RSS endpoint in the documentation would be amazing, and updating the pypi profile such that the documentation is also available there (currently the page for the newest release is completely blank for some reason) would probably also be a good move. Thanks again though for maintaining this! I know just how much of a thankless job that can be sometimes.