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

Cleaner README for cqrs #77

Open
5 tasks
Albert221 opened this issue Jul 14, 2022 · 0 comments
Open
5 tasks

Cleaner README for cqrs #77

Albert221 opened this issue Jul 14, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation p: cqrs Related to the cqrs package
Milestone

Comments

@Albert221
Copy link
Member

Albert221 commented Jul 14, 2022

As the package got more mature it's a good moment to enhance its README with a bit more advanced features.

Any feedback is welcome.

The current proposal for enhancements:

  • Description of Query, Command, and Operation CQRS methods, abstractly.
    • Describing ValidationErrors
  • Note showing how to create a query/command
    • Note shortly introducing to the Dart contracts generator.
      Yes, the package isn't tied with the generator anyhow, but in real life, those two are at least almost always used together and it'd be a good idea to explain the concept with real use-case tips.
  • Maybe a simple graphical (i.e. a logo) for the package?
@Albert221 Albert221 added documentation Improvements or additions to documentation p: cqrs Related to the cqrs package labels Jul 14, 2022
@Albert221 Albert221 added this to the cqrs v8.0.0 milestone Jul 14, 2022
@Albert221 Albert221 self-assigned this Jul 14, 2022
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 p: cqrs Related to the cqrs package
Projects
None yet
Development

No branches or pull requests

1 participant