Skip to content

Commit

Permalink
docs: add template.json
Browse files Browse the repository at this point in the history
  • Loading branch information
carlhong committed Nov 7, 2022
1 parent 65811ad commit a4b647e
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 18 deletions.
34 changes: 16 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,43 +29,41 @@ Here is a [pr example](https://github.com/subscan-explorer/projects-info/pull/58
1. description file (\<network\>.json)
2. network icon image as SVG or PNG (recommend 512x512 and SVG)
3. cover image as SVG or PNG (unnecessary)

> If you want to request new/updated project info, You need to follow these steps:
(If you have submitted project info and only want to update resouces without a description file, you can skip the signature step)

1. put your description file in the right folder like `networks/kusama/parachain/<network>.json`
2. put your image to `assets/images/<network>.<svg/png>`
2. put your images to `assets/images/<network>.<svg/png>`
3. go [polkadot apps signing](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frpc.polkadot.io#/signing) to sign your description file content (**paste all content of the description file**) with **The parachain owner account**
4. make a pull request to our repo, and replace placeholders of `Para ID Owner & Signature Account` and `Signature Hash` of `Signature Auto check` by the Owner account and Signature
5. check all of the checklist
6. done, now you can create and wait for the Signature Checker to pass your request, and our team will double-check and confirm your request

## How to make a description file

Here is a template you can refer to, don't worry about indentation and spaces, you just need to make sure it's in valid JSON format
Here is a [template.json](https://github.com/subscan-explorer/projects-info/blob/main/networks/polkadot/parachain/template.json) you can refer to, don't worry about indentation and spaces, you just need to make sure it's in valid JSON format

```json
{
"data": {
"ParaID": 2046,
"Project Name": "darwinia",
"Logo": "../../assets/images/darwinia.png",
"Description (en)": "Darwinia is a cross-chain messaging infrastructure. Darwinia provides a reliable and programmable cross-chain platform for decentralized applications. Darwinia provides developers with an SDK, and developers can easily integrate cross-chain capabilities into their Dapps.",
"Description (zh)": "Darwinia is a cross-chain messaging infrastructure. Darwinia provides a reliable and programmable cross-chain platform for decentralized applications. Darwinia provides developers with an SDK, and developers can easily integrate cross-chain capabilities into their Dapps.",
"Parachain Crowdloans Allocation (en)": "<LEAVE HERE A LINK OR EMPTY>",
"Parachain Crowdloans Allocation (zh)": "<LEAVE HERE A LINK OR EMPTY>",
"ParaID": 2000,
"Project Name": "",
"Logo": "../../assets/images/[logo file name]",
"Cover": "../../assets/images/[cover file name]",
"Description (en)": "",
"Description (zh)": "",
"Auction Reward & Reward Vesting Schedule (en)": "<LEAVE HERE A LINK OR EMPTY>",
"Auction Reward & Reward Vesting Schedule (zh)": "<LEAVE HERE A LINK OR EMPTY>",
"Financing Information (en)": "<LEAVE HERE A LINK OR EMPTY>",
"Financing Information (zh)": "<LEAVE HERE A LINK OR EMPTY>",
"Website Link": "https://darwinia.network/",
"Twitter Link": "https://twitter.com/DarwiniaNetwork",
"Telegram Link": "https://t.me/DarwiniaNetwork",
"Discord Link": "https://discord.gg/KSJGA29Xz5",
"Medium Link": "https://medium.com/@DarwiniaNetwork",
"Github Link": "https://github.com/darwinia-network",
"Owner account": "<THE PARACHAIN OWNER ACCOUNT>"
"Website Link": "<LEAVE HERE A LINK OR EMPTY>",
"Twitter Link": "<LEAVE HERE A LINK OR EMPTY>",
"Telegram Link": "<LEAVE HERE A LINK OR EMPTY>",
"Discord Link": "<LEAVE HERE A LINK OR EMPTY>",
"Medium Link": "<LEAVE HERE A LINK OR EMPTY>",
"Github Link": "<LEAVE HERE A LINK OR EMPTY>",
"Owner account": ""
}
}
```
Expand Down
19 changes: 19 additions & 0 deletions networks/polkadot/parachain/template.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"data": {
"ParaID": 2000,
"Project Name": "",
"Logo": "../../assets/images/[logo file name]",
"Cover": "../../assets/images/[cover file name]",
"Description (en)": "",
"Description (zh)": "",
"Auction Reward & Reward Vesting Schedule (en)": "<LEAVE HERE A LINK OR EMPTY>",
"Auction Reward & Reward Vesting Schedule (zh)": "<LEAVE HERE A LINK OR EMPTY>",
"Website Link": "<LEAVE HERE A LINK OR EMPTY>",
"Twitter Link": "<LEAVE HERE A LINK OR EMPTY>",
"Telegram Link": "<LEAVE HERE A LINK OR EMPTY>",
"Discord Link": "<LEAVE HERE A LINK OR EMPTY>",
"Medium Link": "<LEAVE HERE A LINK OR EMPTY>",
"Github Link": "<LEAVE HERE A LINK OR EMPTY>",
"Owner account": ""
}
}

0 comments on commit a4b647e

Please sign in to comment.