chore(public): Improve Universal Router README with clearer instructions and example - Githubissues

Uniswap / sdks

prototype SDK monorepo

38 stars 49 forks source link

chore(public): Improve Universal Router README with clearer instructions and example #119

Open jfbloom22 opened 5 days ago

jfbloom22 commented 5 days ago

Description

This PR updates the README of the universal-router-sdk to provide clearer and more comprehensive installation instructions. The changes include:

Added installation instructions for npm.
Updated the "Note" about swapERC20CallParameters()
Improved the overall structure and readability of the installation and usage sections.

These changes aim to make it easier for new users to get started with the SDK

How Has This Been Tested?

The changes in this PR are documentation updates and do not affect the codebase. However, I have:

Manually reviewed the changes for accuracy and clarity.
Ensured that the code examples in the README are consistent with the current SDK usage.

Are there any breaking changes?

No, there are no breaking changes. This PR only updates the README file.

Feedback Focus

I'd appreciate feedback on:

The clarity and completeness of the new example code.
The overall structure and flow of the updated README sections.
Any additional information that might be helpful for new users of the SDK.

Follow Ups

Potential follow-up tasks could include:

Adding more detailed examples for different use cases of the SDK.
Creating a separate "Getting Started" guide for more in-depth setup instructions.