Improve SDK documentation #377 #427
Open
Conversation
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
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.
I've completed the improvement and expansion of the npm-package.md documentation. The updated documentation now includes:
A comprehensive introduction to the Enclosed library
Clear installation instructions
Basic usage examples for creating and reading notes
Detailed API reference for all main functions (createNote, decryptNote, fetchNote)
Documentation for URL and file handling functions
A new section on TypeScript types and interfaces as requested
Advanced usage examples (password protection, expiration, file attachments)
Error handling guidance
Complete end-to-end examples