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.

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.md #494

Merged
merged 8 commits into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
58 changes: 43 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
# **Polkadart**
[![Star on Github](https://img.shields.io/github/stars/leonardocustodio/polkadart.svg?style=flat&logo=github&colorB=deeppink&label=stars)](https://github.com/leonardocustodio/polkadart)
[![All Contributors](https://img.shields.io/github/all-contributors/leonardocustodio/polkadart?color=ee8449&style=flat-square)](#contributors)
[![Test Coverage](https://codecov.io/gh/leonardocustodio/polkadart/graph/badge.svg?token=HG3K4LW5UN)](https://codecov.io/gh/leonardocustodio/polkadart)
[![Build and Tests](https://github.com/leonardocustodio/polkadart/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/leonardocustodio/polkadart/actions/workflows/tests.yml)
[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-purple.svg)](https://www.apache.org/licenses/LICENSE-2.0) <!-- markdown-link-check-disable-line -->
<p align="center">
<img src="https://raw.githubusercontent.com/leonardocustodio/polkadart/main/resources/polkadart-logo.png" height="100" alt="Polkadart" />
</p>

<p align="center">
<a href="https://github.com/leonardocustodio/polkadart"><img src="https://img.shields.io/github/stars/leonardocustodio/polkadart.svg?style=flat&logo=github&colorB=deeppink&label=Stars" alt="Star on Github"></a>
<a href="https://github.com/leonardocustodio/polkadart/actions/workflows/tests.yml"><img src="https://github.com/leonardocustodio/polkadart/actions/workflows/tests.yml/badge.svg?branch=main" alt="build"></a>
<a href="https://codecov.io/gh/leonardocustodio/polkadart"><img src="https://img.shields.io/codecov/c/github/leonardocustodio/polkadart?label=Codecov&token=HG3K4LW5UN" alt="Codecov"></a>
<a href="#contributors"><img src="https://img.shields.io/github/all-contributors/leonardocustodio/polkadart?color=ee8449&style=flat-square&label=All%20Contributors" alt="All contributors"></a>
<a href="https://www.apache.org/licenses/LICENSE-2.0"><img src="https://img.shields.io/badge/license-Apache%202.0-purple.svg?label=License" alt="License: Apache 2"></a>
<a href="https://t.me/polkadart"><img src="https://img.shields.io/badge/Chat-Telegram-blue.svg?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZD0iTTEyIDI0YzYuNjI3IDAgMTItNS4zNzMgMTItMTJTMTguNjI3IDAgMTIgMCAwIDUuMzczIDAgMTJzNS4zNzMgMTIgMTIgMTJaIiBmaWxsPSJ1cmwoI2EpIi8+PHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik01LjQyNSAxMS44NzFhNzk2LjQxNCA3OTYuNDE0IDAgMCAxIDYuOTk0LTMuMDE4YzMuMzI4LTEuMzg4IDQuMDI3LTEuNjI4IDQuNDc3LTEuNjM4LjEgMCAuMzIuMDIuNDcuMTQuMTIuMS4xNS4yMy4xNy4zMy4wMi4xLjA0LjMxLjAyLjQ3LS4xOCAxLjg5OC0uOTYgNi41MDQtMS4zNiA4LjYyMi0uMTcuOS0uNSAxLjE5OS0uODE5IDEuMjI5LS43LjA2LTEuMjI5LS40Ni0xLjg5OC0uOS0xLjA2LS42ODktMS42NDktMS4xMTktMi42NzgtMS43OTgtMS4xOS0uNzgtLjQyLTEuMjA5LjI2LTEuOTA4LjE4LS4xOCAzLjI0Ny0yLjk3OCAzLjMwNy0zLjIyOC4wMS0uMDMuMDEtLjE1LS4wNi0uMjEtLjA3LS4wNi0uMTctLjA0LS4yNS0uMDItLjExLjAyLTEuNzg4IDEuMTQtNS4wNTYgMy4zNDgtLjQ4LjMzLS45MDkuNDktMS4yOTkuNDgtLjQzLS4wMS0xLjI0OC0uMjQtMS44NjgtLjQ0LS43NS0uMjQtMS4zNDktLjM3LTEuMjk5LS43OS4wMy0uMjIuMzMtLjQ0Ljg5LS42NjlaIiBmaWxsPSIjZmZmIi8+PGRlZnM+PGxpbmVhckdyYWRpZW50IGlkPSJhIiB4MT0iMTEuOTkiIHkxPSIwIiB4Mj0iMTEuOTkiIHkyPSIyMy44MSIgZ3JhZGllbnRVbml0cz0idXNlclNwYWNlT25Vc2UiPjxzdG9wIHN0b3AtY29sb3I9IiMyQUFCRUUiLz48c3RvcCBvZmZzZXQ9IjEiIHN0b3AtY29sb3I9IiMyMjlFRDkiLz48L2xpbmVhckdyYWRpZW50PjwvZGVmcz48L3N2Zz4K" alt="Telegram"></a>
</p>

---

<img align="right" width="400" src="https://raw.githubusercontent.com/w3f/Grants-Program/00855ef70bc503433dc9fccc057c2f66a426a82b/static/img/badge_black.svg" />

Expand All @@ -30,18 +38,36 @@ This repo is a monorepo for `polkadart` and related packages.
## Documentation

- [Official documentation](https://polkadart.dev)
- [polkadart package](https://pub.dev/documentation/polkadart/latest/)
- [polkadart_cli package](https://pub.dev/documentation/polkadart_cli/latest/)
- [polkadart_keyring package](https://pub.dev/documentation/polkadart_keyring/latest/)
- [polkadart_scale_codec package](https://pub.dev/documentation/polkadart_scale_codec/latest/)
- [secp256k1_ecdsa package](https://pub.dev/documentation/secp256k1_ecdsa/latest/)
- [sr25519 package](https://pub.dev/documentation/sr25519/latest/)
- [ss58 package](https://pub.dev/documentation/ss58/latest/)
- [substrate_bip39 package](https://pub.dev/documentation/substrate_bip39/latest/)
- [substrate_metadata package](https://pub.dev/documentation/substrate_metadata/latest/)
- [polkadart Package](https://pub.dev/documentation/polkadart/latest/)
- [polkadart_cli Package](https://pub.dev/documentation/polkadart_cli/latest/)
- [polkadart_keyring Package](https://pub.dev/documentation/polkadart_keyring/latest/)
- [polkadart_scale_codec Package](https://pub.dev/documentation/polkadart_scale_codec/latest/)
- [secp256k1_ecdsa Package](https://pub.dev/documentation/secp256k1_ecdsa/latest/)
- [sr25519 Package](https://pub.dev/documentation/sr25519/latest/)
- [ss58 Package](https://pub.dev/documentation/ss58/latest/)
- [substrate_bip39 Package](https://pub.dev/documentation/substrate_bip39/latest/)
- [substrate_metadata Package](https://pub.dev/documentation/substrate_metadata/latest/)

## Community

- [Telegram](https://t.me/polkadart) - A developer group where you can share your experience and ask for help

## Contributing

There are many ways for you to contribute to the growing community of Polkadart.
- Propose new features and enhancements
- Report or fix a bug
- Write and improve our documentation
- Translate our documentation
- Add new snippets and examples
- Implement new features by sending pull requets

Contributions of any kind are always welcome! ❤️

## Contributors

A heartfelt thank you to all the contributors for enriching the Polkadart project! [emojis](https://allcontributors.org/docs/en/emoji-key)

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
Expand Down Expand Up @@ -77,6 +103,8 @@ This repo is a monorepo for `polkadart` and related packages.

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## **License**

This repository is licensed under [Apache 2.0 license](https://github.com/leonardocustodio/polkadart/blob/main/LICENSE)
Expand Down
Binary file added resources/polkadart-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 46 additions & 0 deletions resources/polkadart.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading