Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Readme of the polkadot crate #5326

Merged
merged 6 commits into from
Aug 15, 2024
Merged

Update Readme of the polkadot crate #5326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cff405b
Update polkadot readme
rzadp Aug 12, 2024
cf4f074
Add prdoc
rzadp Aug 12, 2024
9c767a5
Update prdoc/pr_5326.prdoc
rzadp Aug 15, 2024
68544b9
Merge branch 'master' into rzadp/polkadot-readme
rzadp Aug 15, 2024
e47e7a9
ci rerun
rzadp Aug 15, 2024
19ed25b
Merge branch 'master' into rzadp/polkadot-readme
rzadp Aug 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 11 additions & 14 deletions polkadot/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,8 @@ Connect to the global Polkadot Mainnet network by running:
../target/release/polkadot --chain=polkadot
```

You can see your node on [telemetry] (set a custom name with `--name "my custom name"`).

[telemetry](https://telemetry.polkadot.io/#list/Polkadot): https://telemetry.polkadot.io/#list/Polkadot
You can see your node on [Polkadot telemetry](https://telemetry.polkadot.io/#list/0x91b171bb158e2d3848fa23a9f1c25182fb8e20313b2c1eb49219da7a70ce90c3)
(set a custom name with `--name "my custom name"`).

### Connect to the "Kusama" Canary Network

Expand All @@ -115,9 +114,8 @@ Connect to the global Kusama canary network by running:
../target/release/polkadot --chain=kusama
```

You can see your node on [telemetry] (set a custom name with `--name "my custom name"`).

[telemetry](https://telemetry.polkadot.io/#list/Kusama): https://telemetry.polkadot.io/#list/Kusama
You can see your node on [Kusama telemetry](https://telemetry.polkadot.io/#list/0xb0a8d493285c2df73290dfb7e61f870f17b41801197a149ca93654499ea3dafe)
(set a custom name with `--name "my custom name"`).

### Connect to the Westend Testnet

Expand All @@ -127,9 +125,8 @@ Connect to the global Westend testnet by running:
../target/release/polkadot --chain=westend
```

You can see your node on [telemetry] (set a custom name with `--name "my custom name"`).

[telemetry](https://telemetry.polkadot.io/#list/Westend): https://telemetry.polkadot.io/#list/Westend
You can see your node on [Westend telemetry](https://telemetry.polkadot.io/#list/0xe143f23803ac50e8f6f8e62695d1ce9e4e1d68aa36c1cd2cfd15340213f3423e)
(set a custom name with `--name "my custom name"`).

### Obtaining DOTs

Expand All @@ -147,7 +144,7 @@ Then, grab the Polkadot source code:

```bash
git clone https://github.com/paritytech/polkadot-sdk.git
cd polkadot
cd polkadot-sdk
```

Then build the code. You will need to build in release mode (`--release`) to start a network. Only
Expand Down Expand Up @@ -185,7 +182,7 @@ You can run a simple single-node development "network" on your machine by runnin
cargo run --bin polkadot --release -- --dev
```

You can muck around by heading to <https://polkadot.js.org/apps> and choose "Local Node" from the
You can muck around by heading to <https://polkadot.js.org/apps> and choosing "Local Node" from the
Settings menu.

### Local Two-node Testnet
Expand Down Expand Up @@ -214,11 +211,11 @@ that we currently maintain.

### Using Docker

[Using Docker](../docs/contributor/docker.md)
[Using Docker](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/docker.md)

### Shell Completion

[Shell Completion](doc/shell-completion.md)
[Shell Completion](https://github.com/paritytech/polkadot-sdk/blob/master/polkadot/doc/shell-completion.md)

## Contributing

Expand All @@ -232,4 +229,4 @@ that we currently maintain.

## License

Polkadot is [GPL 3.0 licensed](LICENSE).
Polkadot is [GPL 3.0 licensed](https://github.com/paritytech/polkadot-sdk/blob/master/polkadot/LICENSE).
13 changes: 13 additions & 0 deletions prdoc/pr_5326.prdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Schema: Polkadot SDK PRDoc Schema (prdoc) v1.0.0
# See doc at https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/prdoc/schema_user.json

title: Update Readme of the `polkadot` crate
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is probably not needed, but harmless.


doc:
- audience: Node Operator
description: |
Updated Readme of the `polkadot` crate.

crates:
- name: polkadot
bump: patch
Loading