Update README to match context-based API implementation#3
Merged
Conversation
Co-authored-by: JohnAmadis <17320783+JohnAmadis@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update README to reflect current implementation
Update README to match context-based API implementation
Nov 7, 2025
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.
The README documented an obsolete
dmenv_init(buffer, size)API that no longer exists. The implementation uses a context-based approach withdmenv_create(parent).Changes
All code examples: Updated to use
dmenv_create(NULL)instead ofdmenv_init(buffer, size), added context parameters to all function calls, and added proper cleanup withdmenv_destroy(ctx)API Reference: Replaced initialization section with context management functions (
dmenv_create,dmenv_destroy,dmenv_is_valid,dmenv_set_as_default,dmenv_get_default), added context parameters to all function signatures, documented integer operations (dmenv_seti/dmenv_geti)Overview sections: Updated Features, Overview, and "What is dmenv?" to describe context-based management and inheritance capabilities
Example
Before:
After:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.