Skip to content

Commit

Permalink
Clarify branches in README (#322)
Browse files Browse the repository at this point in the history
  • Loading branch information
CodeSandwich committed Oct 11, 2023
1 parent 19e7b67 commit 44d6752
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
# Radicle Drips protocol V2 smart contracts
# Drips protocol V2 smart contracts

Radicle Drips is an EVM blockchain protocol for streaming and splitting ERC-20 tokens.
Drips is an EVM blockchain protocol for streaming and splitting ERC-20 tokens.
See [docs](https://docs.drips.network) for a high-level introduction and documentation.

# Organization of the repository

The `main` branch is always in-development, it contains the newest
version of the contracts that may not be deployed anywhere.

The hashes of the git commits that were used for deployments can be found
in the `deployments` directory, in the JSON files under the `Commit hash` key.
These commits are also git tagged using the `v2_<chain_name>_deploy` naming scheme,
e.g. `v2_ethereum_deploy`.

The deployed contracts for the old, v1 version of the protocol can be found on the `v1` branch.

# Development
Radicle Drips uses [Foundry](https://github.com/foundry-rs/foundry) for development.
Drips uses [Foundry](https://github.com/foundry-rs/foundry) for development.
You can install it using [foundryup](https://github.com/foundry-rs/foundry#installation).

The codebase is statically checked with [Slither](https://github.com/crytic/slither) version 0.9.5.
Expand Down

0 comments on commit 44d6752

Please sign in to comment.