Skip to content

Conversation

Nalon
Copy link
Collaborator

@Nalon Nalon commented Sep 29, 2025

This PR updates the Chainlink Smart Contracts README to improve clarity, add structured setup instructions, and align documentation with the latest package changes (v1.5.0). The goal is to make installation, configuration, and usage across different Solidity development environments more straightforward.

Changes to README.md:

  • Notes about unvendoring and abi directory changes in v1.5.0
  • Includes supporting information around the use of remappings
  • Includes setup instructions by environment (Foundry, Hardhat 3, Hardhat 2, Remix)
  • Links to starter kits for working examples

Nalon and others added 3 commits September 28, 2025 17:17
Updated instructions for v1.5.0.

v1.5.0 unvendors a number of contracts, which require the use of remappings to resolve import paths of package dependencies. Included instructions and information to support this.

- Foundry
- Hardhat 3
- Hardhat 2
- Remix
- Supporting information
- Updated HH3 starter kit url to hardhat-3 branch
- Updated link to remapping section of HH SK readme (HH2)
- Added line for HH2 working examples for consistency
- Minor phrasing changes
@Nalon Nalon changed the title Updated README for v1.5.0 Updated README for Contracts-v1.5.0 Sep 29, 2025
- Fixed markdown tags
- Updated forge install text to reference forge starter kit
- Removed libs step for foundry
- Removed duplicate usage steps
@matYang matYang marked this pull request as ready for review September 30, 2025 19:50
@matYang matYang requested a review from a team as a code owner September 30, 2025 19:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants