docs(builder): add README documentation#430
Merged
Merged
Conversation
Contributor
SCC Complexity Analysis
|
commit: |
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.
This pull request introduces a patch release for
@aziontech/builderfocused on improving documentation and package configuration. The most significant change is the addition of a comprehensiveREADME.mdto guide users in installing and using the builder utilities for Azion's platform. There are also minor adjustments to package metadata and workflow comments for clarity.Documentation improvements:
README.mdtopackages/builder, covering installation, usage examples with esbuild and webpack, feature descriptions, polyfill usage, API reference, and contribution guidelines.filesarray inpackages/builder/package.jsonto include the newREADME.mdin published files.Release and workflow adjustments:
@aziontech/buildernoting the new README. (.changeset/huge-sheep-flash.md)NODE_AUTH_TOKENline in.github/workflows/release.ymlto clarify that it's only needed when publishing a new package.Other package metadata:
@aziontech/clientas private in itspackage.jsonto prevent accidental publishing.