docs: specify version for attachment functionality#72
Merged
mantariksh merged 5 commits intodevelopfrom Jun 17, 2021
Merged
Conversation
README.md
Outdated
| // Decrypt the submission and attachments | ||
| async function (req, res, next) { | ||
| const submission = formsg.crypto.decryptWithAttachments( | ||
| // Note that this function is only available from version 0.9.0 onwards |
Contributor
There was a problem hiding this comment.
I think this line is not necessary, as it's already documented below. I'd also like this section to be a "quick start" that is as short, friendly and un-intimidating as possible. Do you think we can simplify further, say by combining /submissions with /submissions-attachment?
Contributor
Author
There was a problem hiding this comment.
addressed in 3c49a9c, could you help take a look to see if it makes sense please?
liangyuanruo
approved these changes
Jun 16, 2021
Contributor
liangyuanruo
left a comment
liangyuanruo
left a comment
There was a problem hiding this comment.
pre-approving documentation changes
Contributor
Author
|
got some final feedback from @karrui and @LoneRifle, thank you for the inputs! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds notes to the README to clarify that
decryptWithAttachmentsis only available from v0.9.0 onwards, and also adds a missingawaitto the example code.