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

If, when and how should I use SwissSchema? #3

Open
joeljuca opened this issue Jul 11, 2023 · 1 comment
Open

If, when and how should I use SwissSchema? #3

joeljuca opened this issue Jul 11, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@joeljuca
Copy link
Owner

joeljuca commented Jul 11, 2023

This module implements functionality that's similar to what some object-oriented frameworks do: it puts the data schema definition and the data manipulation functions together. It doesn't tie data to functions, but it contrasts with the Phoenix culture of using context modules to provide external-facing data manipulation functions. This difference might bring confusion to developers wondering if, how, and when they should use this library.

So, covering these questions/wonderings right in the README.md might just make sure users are properly educated about the goods and bads of this approach.

An entry in FAQ.md should be added to cover this questions.

@joeljuca joeljuca self-assigned this Nov 8, 2023
@joeljuca joeljuca added the documentation Improvements or additions to documentation label Nov 8, 2023
@joeljuca
Copy link
Owner Author

We have a FAQ.md now, so it's better to just move this content to it and link it in the README.md.

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

No branches or pull requests

1 participant