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

Make README up-to-date #124

Closed
MartinKanters opened this issue Dec 8, 2023 · 3 comments · Fixed by #135
Closed

Make README up-to-date #124

MartinKanters opened this issue Dec 8, 2023 · 3 comments · Fixed by #135

Comments

@MartinKanters
Copy link
Collaborator

MartinKanters commented Dec 8, 2023

The README is currently quite outdated, as it even states that you have to build the library yourself.
Also, I think it would be best to stop focussing so much on the encryption, since probably a lot of potential consumers might not handle sensitive data.
The How To should probably be a bit higher up as well, to ensure people can see how it works in one glance.

Could you please make it up to date? :)

@erwinc1
Copy link
Contributor

erwinc1 commented Jan 22, 2024

Heya @MartinKanters can you re-evaluate, please? There have been changes since this issue was created :)

@MartinKanters
Copy link
Collaborator Author

Sure @erwinc1 !

I think it's definitely improved, but perhaps the following things can be changed:

  • There are two Getting Started's and the content is very similar. I think it's best to remove the first block.
  • The first point of the 2nd getting started can be removed (that's saying that you have to build the lib yourself)
  • The README says in multiple places that it's required to setup keys to get insight in the data-comparison. This will have a demotivational effect on the reader, since it's usually not very easy to set up and use. Your team also introduced the NoopEncryptionService which allows to see the data difference without setting up keys. I'd definitely put that in the README as well.

@MartinKanters
Copy link
Collaborator Author

Nice job! Looks much better like this! 👍

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

Successfully merging a pull request may close this issue.

2 participants