Skip to content

Commit

Permalink
docs: update top level readme for repo (#981)
Browse files Browse the repository at this point in the history
* Update base.css

* Update README.md

* smol

---------

Co-authored-by: Marius Poke <marius.poke@posteo.de>
  • Loading branch information
shaspitz and mpoke authored May 30, 2023
1 parent e886855 commit 73b4a07
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 5 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,9 @@
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=cosmos_interchain-security&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=cosmos_interchain-security)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=cosmos_interchain-security&metric=coverage)](https://sonarcloud.io/summary/new_code?id=cosmos_interchain-security)

**interchain-security** houses the code for implementing Interchain Security. The repo is currently a WIP and targetting v1 of Interchain Security. For more details on the Interchain Security protocol, take a look at the [specification](https://github.com/cosmos/ibc/blob/main/spec/app/ics-028-cross-chain-validation/README.md).
**interchain-security** contains a working and in-production implementation of the Replicated Security protocol (aka Interchain Security V1). Replicated security is an open sourced IBC application which allows cosmos blockchains to lease their proof-of-stake security to one another.

CCV stands for cross chain validation and refers to the subset of Interchain Security related to the staking and slashing communication between the provider and consumer blockchains. The provider blockchain communicates staking changes to consumer blockchain(s), while the consumer blockchain may communicate slashing evidence to the provider blockchain.

The code for CCV is housed under [x/ccv](./x/ccv). The `types` folder contains types and related functions that are used by both provider and consumer chains, while the `consumer` module contains the code run by consumer chains and the `provider` module contains the code run by provider chain.
For more details on the Replicated Security protocol, take a look at the [docs](https://cosmos.github.io/interchain-security/) or [technical specification](https://github.com/cosmos/ibc/blob/main/spec/app/ics-028-cross-chain-validation/README.md).

## Instructions

Expand Down
1 change: 0 additions & 1 deletion docs/src/css/base.css
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
-webkit-font-feature-settings: 'kern', 'liga', 'calt', 'zero' 0;
text-size-adjust: 100%;
-moz-osx-font-smoothing: grayscale;
font-smoothing: antialiased;
font-variant-ligatures: contextual common-ligatures;
font-kerning: normal;
text-rendering: optimizeLegibility;
Expand Down

0 comments on commit 73b4a07

Please sign in to comment.