Skip to content

Commit

Permalink
chore: update README.md (#325)
Browse files Browse the repository at this point in the history
* add badges

* typo

* typo

* add discord

* reformat table

---------

Co-authored-by: Ajaz Ahmed Ansari <[email protected]>
  • Loading branch information
Alex Johnson and ajansari95 authored Mar 1, 2023
1 parent 6367496 commit f865ec1
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
# Quicksilver


| | | | | |
|------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| [![codecov](https://codecov.io/gh/ingenuity-build/quicksilver/branch/main/graph/badge.svg)](https://codecov.io/gh/ingenuity-build/quicksilver) | [![Go Report Card](https://goreportcard.com/badge/github.com/ingenuity-build/quicksilver)](https://goreportcard.com/report/github.com/ingenuity-build/quicksilver) | [![license](https://img.shields.io/github/license/ingenuity-build/quicksilver.svg)](https://github.com/ingenuity-build/quicksilver/blob/main/LICENSE) | [![GolangCI](https://golangci.com/badges/github.com/ingenuity-build/quicksilver.svg)](https://golangci.com/r/github.com/ingenuity-build/quicksilver) | [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/quicksilverprotocol) |

Quicksilver is the Cosmos Liquid Staking Zone.

Many existing Liquid Staking providers take power and agency _away_ from delegators, permitting only a small whitelist
of validators to delegate to, and stripping away users voting rights. Quicksilver aims to right these wrongs, with
active measures to reward and incentivise decentralisation and governance participation.


## System Requirements
This system spec has been found to be optimal:

1. Quad Core AMD or Intel (amd64) CPU; higher clock speed is preferrential to more cores, as Tendermint is largely single-threaded.
1. Quad Core AMD or Intel (amd64) CPU; higher clock speed is preferential to more cores, as Tendermint is largely single-threaded.
2. 32GB RAM
3. 1TB NVMe Storage (mechanical disk are insufficient)
4. 100Mbps bidirectional Internet connection
Expand Down Expand Up @@ -58,7 +64,7 @@ For subsequent tests run the following if you want to start with fresh state:

## Origination and Attribution

Quicksilver utilises code and logic that originated from other projects; as an open-source project ourselves, we believe that appropriate attribution is neccessary, in order to combat plagarism.
Quicksilver utilises code and logic that originated from other projects; as an open-source project ourselves, we believe that appropriate attribution is necessary, in order to combat plagiarism.

The following modules were lifted and reused in almost entirety from Osmosis (<https://github.com/osmosis-labs/osmosis>), under the terms of the Apache 2.0 License, and we are grateful for their contribution:

Expand Down

0 comments on commit f865ec1

Please sign in to comment.