Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jessie-park authored May 10, 2024
1 parent 86bb3d5 commit 099e7db
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Initia Registry

This repo contains files `chain.json` and `assetlist.json` for a number of chains in the Initia ecosystem. `chain.json` contains data that makes it easy to start running or interacting with a node.
The Initia Registry serves as a central repository containing crucial metadata for chains within the Initia ecosystem.

Schema files containing the recommended metadata structure can be found in the `*.schema.json` files located in the root directory. Schemas are still undergoing revision as user needs are surfaced. Optional fields may be added beyond what is contained in the schema files.
It houses configuration files such as ```chain.json``` and ```assetlist.json```, which are vital for initiating and interacting with nodes, as well as understanding the available assets on each chain. Additionally, the registry includes ```*.schema.json``` files in the root directory, outlining the recommended metadata structure. These schemas are dynamic, subject to revisions based on evolving user needs, and may include optional fields beyond the current schema specifications.

## Adding Minitia to Initia Registry

1. **Fork the Repository**: Begin by forking the repository where the Initia Registry is hosted.
2. **Add a New Directory**: Create a directory named after the chain you intend to add.
3. **Include Necessary Files**:
- ```chain.json```: Populate this file with the metadata of the chain.
- ```assetlist.json```: Include metadata concerning the assets available on the chain.
- ```initia-minitia.json```: Provide metadata about the IBC connections and channels, ensuring the file name adheres to the alphabetical order of the chain names, e.g., Achain-Bchain.json.
4. **Create a Pull Request**: Submit your modifications for review to merge them into the main repository.

0 comments on commit 099e7db

Please sign in to comment.