Revamp README.md with improved structure & formatting #12
Conversation
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
NikolaiKryshnev
commented
Feb 4, 2025
NikolaiKryshnev
commented
- Added GitHub badges for better repository insights
- Enhanced project overview with a clear description of RedStone Oracles
- Organized package list in a structured table for readability
- Included step-by-step installation guide for easier setup
- Improved contribution section with testing & linting commands
- Redesigned contact section with social media buttons
- Added a dedicated license section for clarity
Do not publish packages to npm we don't want
Mistake in [PR](redstone-finance/redstone-monorepo-priv#4025), cannot publish all packages
I made mistake in changing privacy in packages and this release only fixes it
So stuupid ..
- made some packages public - added `publishConfig` where it was needed - added script for generating paths to sync to public repo based on package.json files which also checks if a public package has private `false` or absent and `publishConfig.access: public` - added script to validate file in GitHub with generated through a script which runs in sync-repo CI --------- Co-authored-by: robal <[email protected]>
These sources are constantly failing  <img width="1612" alt="image" src="https://github.com/user-attachments/assets/deb54110-97a8-4bcc-bd70-0704e73cb111">
empty lines handling --------- Co-authored-by: cehali <[email protected]>
…way (#4586) The main change is that the endpoints that took queryParams are removed from db-less-gateway. The other change is that the sdk doesn't pass any params when making requests.
- removing xei source as it has no liquidity <img width="1506" alt="image" src="https://github.com/user-attachments/assets/1af2bb92-9c40-45ec-b7ab-3c00cc90dbb2" />
- removed sources without liquidity based on errors in node and checking on DEXes 
(REPLACE questions with answers) - Paylaod generator is hardcoded to use primary-prod signers (instead of avalanche one) - We should use primary signers more now - or so I was told/understand it that way - Some scripts may use the old ones since it was hardcoded but this change will enforce/encourage to change singers to primary-prod.
- added simplified version of script where adapter and price feeds are deployed with predefined set of tokens (BTC, ETH, USDT, USDC) - for now disabled option to deploy contracts separetly - updated README accordingly - fixed issue with invalid check for latest version, package.json version was bundled and hardcoded with previous - change requested by Kuba to quickly test push model on chains but not by us
(REPLACE questions with answers) - What has changed (don't be specific about files)? - Why was the change done? - Potential risks or what should be double checked before release?
- added PRIVATE_PACKAGES_TO_SYNC_TO_PUBLIC_REPO and PUBLIC_PACKAGES_TO_NOT_SYNC_TO_PUBLIC_REPO - do not sync `cli` to monorepo, public monorepo is not building due to invalid dependencies (contract-deployments) - sync private packages `movement-connector` and `solanan-connector`
### Description [Ticket](https://redstone-team.atlassian.net/browse/RDS-2037) - Fix feed id - Fix object (PriceAdapter) borrow outside the loop. --------- Co-authored-by: bartossh <[email protected]> Co-authored-by: Jan Koscisz <[email protected]>
- 0.7.4 version - updated CLI - talked with Mike that we can publish SDK - verified with Łukasz non-evm stuff
(REPLACE questions with answers) - What has changed (don't be specific about files)? - Why was the change done? - Potential risks or what should be double checked before release?
Adding new mutli-feed for testnet chain, that will be running on dev env
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
19 participants
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.