docs: improve README and fix .env.example credentials#3
Open
soos3d wants to merge 1 commit into
Open
Conversation
Add prerequisites, environment variables table, and intro paragraph to README. Fix .env.example missing PROJECT_CLIENT_KEY and PROJECT_APP_UUID. Improve Quick Start with explorer link note and update Other example descriptions.
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
1 participant
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.
Summary
Prerequisitessection (Node.js >= 18, Particle dashboard link) and a descriptive intro explaining what Universal Account doesEnvironment Variablessection documenting all 6 vars (required vs optional) so users don't have to dig through example files.env.example: add missing required credentialsPROJECT_CLIENT_KEYandPROJECT_APP_UUID, add optionalUNIVERSAL_ACCOUNT_VERSION, improve commentsuniversalx.apptransaction explorer link