diff --git a/README.md b/README.md index 73fc231..d2f65b4 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,16 @@ # CCIP JavaScript SDK +
+ Deprecation notice: This repository is deprecated and no longer maintained. Instead please use the latest CCIP SDK here. +
+ ### Start here The CCIP JavaScript SDK is a monorepo for two packages: -- [`ccip-js`](/packages/ccip-js/README.md): A TypeScript library that provides a client for managing cross-chain token transfers that use Chainlink's [Cross-Chain Interoperability Protocol (CCIP)](https://docs.chain.link/ccip) routers. -- [`ccip-react-components`](/packages/ccip-react-components/README.md): A set of prebuilt ready-to-use React UI components. This package depends on `ccip-js`. +- [`ccip-js`](/packages/ccip-js/README.md): A TypeScript library that provides a client for managing cross-chain token transfers that use Chainlink's [Cross-Chain Interoperability Protocol (CCIP)](https://docs.chain.link/ccip) routers. +- [`ccip-react-components`](/packages/ccip-react-components/README.md): A set of prebuilt ready-to-use React UI components. This package depends on `ccip-js`. Using both packages, you can add a fully featured CCIP bridge to your app that can be styled to match your app design. @@ -100,10 +104,10 @@ Contributions to either repos are welcome! Please open an issue or submit a pull ## Resources -- [ccip-js README](./packages/ccip-js/README.md) -- [ccip-react-components README](./packages/ccip-react-components/README.md) -- [examples/nextjs README](./examples/nextjs/README.md) -- [Chainlink CCIP Javascript SDK Documentation](https://docs.chain.link/ccip/ccip-javascript-sdk/) -- [Chainlink CCIP Documentation](https://docs.chain.link/ccip) -- [Chainlink CCIP Directory](https://docs.chain.link/ccip/directory) -- [Chainlink Documentation](https://docs.chain.link/) +- [ccip-js README](./packages/ccip-js/README.md) +- [ccip-react-components README](./packages/ccip-react-components/README.md) +- [examples/nextjs README](./examples/nextjs/README.md) +- [Chainlink CCIP Javascript SDK Documentation](https://docs.chain.link/ccip/ccip-javascript-sdk/) +- [Chainlink CCIP Documentation](https://docs.chain.link/ccip) +- [Chainlink CCIP Directory](https://docs.chain.link/ccip/directory) +- [Chainlink Documentation](https://docs.chain.link/) diff --git a/packages/ccip-js/README.md b/packages/ccip-js/README.md index 9669178..db72157 100644 --- a/packages/ccip-js/README.md +++ b/packages/ccip-js/README.md @@ -1,4 +1,8 @@ -# CCIP-JS +# CCIP-JS Package + +
+ Deprecation notice: This package is deprecated and no longer maintained. Instead please use the latest CCIP SDK here. +
CCIP-JS is a TypeScript library that provides a client for managing cross-chain token transfers that use Chainlink's [Cross-Chain Interoperability Protocol (CCIP)](https://docs.chain.link/ccip) routers. The library utilizes types and helper functions from [Viem](https://viem.sh/). diff --git a/packages/ccip-react-components/README.md b/packages/ccip-react-components/README.md index 836d4eb..545dc5d 100644 --- a/packages/ccip-react-components/README.md +++ b/packages/ccip-react-components/README.md @@ -1,5 +1,9 @@ # CCIP-REACT-COMPONENTS +
+ Deprecation notice: This package for React UI components on top of the CCIP-JS package is deprecated and no longer maintained. You can access the latest CCIP SDK here. However note also that there is currently no React Components package that is compatible with the new CCIP SDK. +
+ The CCIP-REACT-COMPONENTS package is a set of prebuilt ready-to-use UI components built on top of [CCIP-JS](../ccip-js/README.md). Using both packages, you can add a fully featured CCIP bridge to your app that can be styled to match your app design. ## Table of contents