feat: add repo badges (vechain#739)

* feat: add repo badges * feat: add repo badges * fix: style * fix: style * revert target blank * fix: docker link * fix: html spaces * fix: update telegram url * Update docs/hosting-a-node.md Co-authored-by: libotony <[email protected]> * chore: md formatting * Update README.md Co-authored-by: libotony <[email protected]> --------- Co-authored-by: libotony <[email protected]>
darrenvechain · May 15, 2024 · ef1cdb5 · ef1cdb5
1 parent 95aed69
commit ef1cdb5
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 22 deletions.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -7,5 +7,5 @@ contact_links:
     url: https://discord.gg/vechain
     about: Join our Discord community to connect with other VeChain enthusiasts, ask questions, and find answers.
   - name: Telegram
-    url: https://t.me/VeChainDevCommunity
+    url: https://t.me/vechainandfriends
     about: Join our Telegram community to connect with other VeChain developers, ask questions, and find answers.
diff --git a/README.md b/README.md
@@ -9,13 +9,37 @@
 
 ---
 
+<p align="center">
+    <a href="https://golang.org"><img src="https://img.shields.io/github/go-mod/go-version/vechain/thor"/></a>
+    <a href="https://github.com/vechain/thor/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-LGPL%20v3-blue.svg"/></a>
+    <img src="https://img.shields.io/github/commits-since/vechain/thor/latest" />
+    <a href="https://hub.docker.com/r/vechain/thor"><img src="https://badgen.net/docker/pulls/vechain/thor?icon=docker&label=pulls"/></a>
+</p>
+
+<p align="center">
+    <a href="https://goreportcard.com/report/github.com/vechain/thor" ><img src="https://goreportcard.com/badge/github.com/vechain/thor"/></a>
+    <img src="https://github.com/vechain/thor/actions/workflows/on-master-commit.yaml/badge.svg"/>
+    <img src="https://github.com/vechain/thor/actions/workflows/on-release.yaml/badge.svg"/>
+    <a href="https://codecov.io/gh/vechain/thor"><img src="https://codecov.io/gh/vechain/thor/graph/badge.svg?token=NniVYY7IAD"/></a>
+<p/>
+
+<p align="center">
+    <a href="https://discord.gg/vechain"><img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white" /></a>
+    <a href="https://t.me/vechainandfriends"><img src="https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white" /></a>
+    <a href="https://www.reddit.com/r/Vechain"><img src="https://img.shields.io/badge/Reddit-FF4500?style=for-the-badge&logo=reddit&logoColor=white"/></a>
+</p>
+
+---
+
 ## Getting Started
 
 VechainThor is the layer 1 blockchain, highly compatible with EVM<sup>*</sup>, which powers the vechain ecosystem.
-VechainThor is a public blockchain that is designed for the mass adoption of blockchain technology by enterprise users of
-all sizes and is intended to serve as a foundation for a sustainable and scalable enterprise blockchain ecosystem.
+VechainThor is a public blockchain that is designed for the mass adoption of blockchain technology by enterprise users
+of all sizes and is intended to serve as a foundation for a sustainable and scalable enterprise blockchain ecosystem.
 
->VechainThor is currently up-to-date with the EVM's `paris` hard fork, set [evmVersion](https://docs.soliditylang.org/en/latest/using-the-compiler.html#setting-the-evm-version-to-target) to `paris` if you are using solidity compiler version `0.8.20` or above.
+> VechainThor is currently up-to-date with the EVM's `paris` hard fork,
+> set [evmVersion](https://docs.soliditylang.org/en/latest/using-the-compiler.html#setting-the-evm-version-to-target)
+> to `paris` if you are using solidity compiler version `0.8.20` or above.
 ___
 
 ## Documentation
@@ -37,8 +61,11 @@ The Vechain Improvement Proposals (VIPs) repository can be found [here](https://
 
 To chat with other community members you can join:
 
-- [Telegram](https://t.me/VechainDevCommunity)
-- [Discord](https://discord.gg/vechain)
+<p>
+    <a href="https://discord.gg/vechain"><img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white" /></a>
+    <a href="https://t.me/vechainandfriends"><img src="https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white" /></a>
+    <a href="https://www.reddit.com/r/Vechain"><img src="https://img.shields.io/badge/Reddit-FF4500?style=for-the-badge&logo=reddit&logoColor=white"/></a>
+</p>
 
 Do note that our [Code of Conduct](./docs/CODE_OF_CONDUCT.md) applies to all vechain community channels. Users are
 **highly encouraged** to read and adhere to them to avoid repercussions.

diff --git a/docs/hosting-a-node.md b/docs/hosting-a-node.md
@@ -8,17 +8,19 @@ requirements may change as the network evolves._
 - [System Requirements](#system-requirements)
   - [Authority Nodes](#authority-nodes)
   - [Public Nodes](#public-nodes)
-- [Important Considerations](#important-considerations)
-  - [Archive Node](#archive-node)
+- [Node Types](#node-types)
+  - [Full Archive Node](#full-archive-node)
   - [Full Node](#full-node)
   - [Full Node without Logs](#full-node-without-logs)
 
-___
+---
 
 ### Command Line Options
 
-Please refer to [Command Line Options](./usage.md#command-line-options) in the usage documentation to see a list of all available options.
-___
+Please refer to [Command Line Options](./usage.md#command-line-options) in the usage documentation to see a list of all
+available options.
+
+---
 
 ### System Requirements
 
@@ -31,7 +33,7 @@ Below spec is the node configured in full node without logs.
 | CPU       | 2 Core                | 4 Core                    |
 | RAM       | 8 GB                  | 16 GB                     |
 | Bandwidth | 10 Mbit               | 20 Mbit                   |
-| Disk      | 300 GB NVMe SSD            | 500 GB NVMe SSD        |
+| Disk      | 300 GB NVMe SSD       | 500 GB NVMe SSD           |
 
 #### Public Nodes
 
@@ -47,15 +49,15 @@ Below spec is the node configured in full archive node.
 | Bandwidth | 10 Mbit               | 20 Mbit                   |
 | Disk      | 600 GB SSD            | 1 TB SSD                  |
 
-___
+---
 
-### Important Considerations
+### Node Types
 
 #### Full Archive Node
 
-A full archive node is a full node that stores all historical data of the blockchain, containing complete historical data of
-all transactions and blocks, including forks and variations. Running a full archive node requires more resources than
-running a regular full node, but it provides access to the complete history of the blockchain.
+A full archive node is a full node that stores all historical data of the blockchain, containing complete historical
+data of all transactions and blocks, including forks and variations. Running a full archive node requires more resources
+than running a regular full node, but it provides access to the complete history of the blockchain.
 
 To run a full archive node, you need to set the `--disable-pruner` flag when starting the node. For example:
 
@@ -81,11 +83,10 @@ _As of 22nd April 2024, a full node uses **~200 GB** of disk space._
 
 #### Full Node without Logs
 
-**Note**: Logs pertain to the transfer and smart contract events recorded on the blockchain, meticulously stored
-within an SQLite database for streamlined querying purposes. The `/logs/event` and `/logs/transfer` endpoints will be
-deactivated when operating a node without logs.
-
-To run a full node without logs, you need to set the `--skip-logs` flag when starting the node. For example:
+- **Logs**: Logs are records of transfer and smart contract events stored in an SQLite database on the blockchain. When
+  operating a node without logs, the /logs/event and /logs/transfer endpoints will be deactivated.
+  These endpoints may experience CPU-intensive requests, causing performance issues. To address this, you can start a
+  node without logs by using the --skip-logs flag. For example:
 
 ```shell
 bin/thor --network main --skip-logs