From e2ef55c5b60db71d7aae788745cfedc273dcabe3 Mon Sep 17 00:00:00 2001 From: Dan Lynch Date: Tue, 25 Jun 2024 17:59:45 -0700 Subject: [PATCH] readme --- README.md | 7 ++++--- packages/chain-registry/README.md | 23 ++++++++++++++++++++--- v2/chain-registry/README.md | 23 ++++++++++++++++++++--- 3 files changed, 44 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f6597b800..3c390f611 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,13 @@

- - - + + +
+

diff --git a/packages/chain-registry/README.md b/packages/chain-registry/README.md index 86d671157..3c390f611 100644 --- a/packages/chain-registry/README.md +++ b/packages/chain-registry/README.md @@ -5,12 +5,13 @@

- - - + + +
+

@@ -231,6 +232,22 @@ git commit -am "new registry updates" lerna publish ``` +### Updating Submodule Data + +Use the following Makefile commands to update the data in the submodules. These commands will ensure that your submodules are synchronized with their respective remote repositories. + +- **update-cosmos**: Updates the submodule to the latest commits of the `cosmos/chain-registry` repository. This should be used to pull the most current production data into your local environment. + +``` +make update-cosmos +``` + +- **update-fixtures**: Updates the submodule to the latest commits of the `cosmology-tech/chain-registry-fixtures` repository. Use this for testing purposes to ensure that your tests are running against stable, controlled data sets. + +``` +make update-fixtures +``` + ## Related Checkout these related projects: diff --git a/v2/chain-registry/README.md b/v2/chain-registry/README.md index 86d671157..3c390f611 100644 --- a/v2/chain-registry/README.md +++ b/v2/chain-registry/README.md @@ -5,12 +5,13 @@

- - - + + +
+

@@ -231,6 +232,22 @@ git commit -am "new registry updates" lerna publish ``` +### Updating Submodule Data + +Use the following Makefile commands to update the data in the submodules. These commands will ensure that your submodules are synchronized with their respective remote repositories. + +- **update-cosmos**: Updates the submodule to the latest commits of the `cosmos/chain-registry` repository. This should be used to pull the most current production data into your local environment. + +``` +make update-cosmos +``` + +- **update-fixtures**: Updates the submodule to the latest commits of the `cosmology-tech/chain-registry-fixtures` repository. Use this for testing purposes to ensure that your tests are running against stable, controlled data sets. + +``` +make update-fixtures +``` + ## Related Checkout these related projects: