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

Write a README #26

Closed
7 tasks done
PawelLipski opened this issue May 4, 2021 · 1 comment
Closed
7 tasks done

Write a README #26

PawelLipski opened this issue May 4, 2021 · 1 comment

Comments

@PawelLipski
Copy link
Collaborator

PawelLipski commented May 4, 2021

  • CI + License + Maven badge (shields.io, see https://github.com/VirtusLab/git-machete-intellij-plugin/ for a sample)
  • Logo (Request a logo from the graphics team #25)
  • Build setup (compiler plugin + dependency)
  • Rationale: why Jackson sucks for Akka and how it's done better here
  • Remember about explicit mentions of Borer! so that it doesn't create an impression that we attribute to ourselves what's actually done by Borer
  • Document sbt settings for dump event schema plugin/options for compiler plugin (maybe not in README but in a separate file? TBD)
  • Document Circe serializer with some Scala snippets
@MarconZet
Copy link
Collaborator

3, 4 and 5 done by #39

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

No branches or pull requests

2 participants