Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
carlhong authored Sep 23, 2022
1 parent 07b6c55 commit 7d91858
Showing 1 changed file with 60 additions and 49 deletions.
109 changes: 60 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,52 +16,63 @@ This repo contains info of projects used in [Subscan parachain module](https://r

Welcome to pr to update your `project information`.

## Example - PR description

> Please add a description for your pr, the description includes the original data of the signature, signature account, and signature.
**Original data of the signature - `project information`:**

ParaID: '0',

Project Name: 'text',

Description (en): 'text',

Description (zh): 'text',

Parachain Crowdloans Allocation (en): 'text or link',

Parachain Crowdloans Allocation (zh): 'text or link',

Auction Reward & Reward Vesting Schedule (en): 'text or link',

Auction Reward & Reward Vesting Schedule (zh): 'text or link',

Financing Information (en): 'text or link',

Financing Information (zh): 'text or link',

Website Link: 'link',

Twitter Link: 'link',

Telegram Link: 'link',

Discord Link: 'link',

Medium Link: 'link',

Github Link: 'link'

---------------

Owner account: ''

Signature: '0x....',

---------------

Logo: ''

> Upload to [Here](https://github.com/itering/parachain-projects-info/tree/main/assets/images)
# How to request a change of network

- [How to request a change of network](#how-to-request-a-change-of-network)
- [How to make a description file](#how-to-make-a-description-file)

## How to start

> If you want to request new project info, You need to prepare these files:
1. description file (\<network\>.json)
2. network icon image as SVG or PNG (recommend 512x512 and SVG)

> 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>`
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

```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>",
"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>"
}
}
```

## Why the Signature Checker report **Not-Verified**

1. Make sure you haven't changed other formats except for angle brackets(\<\>) and included words
2. Make sure the signature you put is made by the same Parachain Owner
3. Make sure your description file is in valid JSON format
4. Probably our Signature checker give up its job :(

If up there is nothing to help, contact us, and we will help you manually verify your request.

0 comments on commit 7d91858

Please sign in to comment.