Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider changing (or redocumenting) the example on the main page #17

Open
stellarpower opened this issue Mar 21, 2022 · 0 comments
Open

Comments

@stellarpower
Copy link

Hi,

I haven't used PODs before, so the first place I'm looking at documentation to get an idea of how difficult or eays it will be ot integrate it into my application is the example on the main readme in the repo.

When I first glossed over it, considering a few different libraries ot use for my project, I got the impression that PODS required a server internally to function - perhaps underneath, the library was setting one up to receive data in the background, etc. etc.

I now realise that this is just because the sort of data we are storing is a list of servers, but this wasn't immediately obvious. Therefore, I think it would be a good idea to add a note on this line explaining what we're doing, or pick a different example of domain data to show on the main page of the repository (something more obvious as an example., like fruits, animals or planets), as without having seen the library before, intermingling Server code and PODS code, it gave me the impression PODs required some sort of more complex Server structure in order to work, and thus it would need a lot more work involved in getting it to work than it really will.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant