docs: add environment setup instructions to README - #69
Open
sessizbarmen wants to merge 4 commits into
Open
Conversation
docs: add environment setup instructions to README
docs: add inline comments and clarify order ID in cancel_orders example
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.
Description
Added a brief "Environment Setup" section to the README.
Previously, there were no instructions for new users on how to configure the
.envfile from the provided.env.example, which is required for setting up API and wallet credentials. Also fixed a minor markdown link formatting issue in the usage section.This should help improve the onboarding experience for new developers exploring the client.
Note
Low Risk
Low risk: documentation/example-only updates with no production code changes. The main risk is minor confusion if the default chain ID comment (Mumbai vs 80002/Amoy) is inaccurate.
Overview
Adds an Environment Setup section to
README.mddescribing how to copy.env.exampleto.envand which credentials (PK,CLOB_API_KEY/CLOB_SECRET/CLOB_PASS_PHRASE) must be set before running examples.Improves onboarding polish by fixing a minor docs link in the usage snippet and adding clarifying comments in
examples/orders/cancel_orders.pyaround env var usage, defaultCHAIN_ID, and replacing the placeholder order ID(s).Reviewed by Cursor Bugbot for commit 6bac943. Bugbot is set up for automated code reviews on this repo. Configure here.