Skip to content

Commit

Permalink
docs: update description and keywords
Browse files Browse the repository at this point in the history
  • Loading branch information
PaulRBerg committed Nov 29, 2023
1 parent 7170ef9 commit 0f6c141
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ In-depth documentation is available at [docs.sablier.com](https://docs.sablier.c

## Background

Sablier is a token streaming protocol that enables by-the-second payments in web3. DAOs and businesses use it for
vesting, payroll, airdrops, and more.
Sablier V2 is a token distribution protocol used by DAOs and businesses for vesting, payroll, airdrops, and more. The
linear stream is our flagship payment model, which distributes assets on a continuous, by-the-second basis.

The sender of a payment stream first deposits a specific amount of ERC-20 tokens in a contract. Then, the contract
progressively allocates the funds to the recipient, who can access them as they become available over time. The payment
rate is influenced by various factors, including the start and end times, as well as the total amount of tokens
deposited.
The way it works is that the sender of a payment stream first deposits a specific amount of ERC-20 tokens in a contract.
Then, the contract progressively allocates the funds to the recipient, who can access them as they become available over
time. The payment rate is influenced by various factors, including the start and end times, as well as the total amount
of tokens deposited.

## Install

Expand Down
9 changes: 7 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@sablier/v2-core",
"description": "Core smart contracts of the Sablier V2 token streaming protocol",
"description": "Core smart contracts of the Sablier V2 token distribution protocol",
"license": "BUSL-1.1",
"version": "1.1.0",
"author": {
Expand All @@ -26,6 +26,7 @@
],
"homepage": "https://github.com/sablier-labs/v2-core#readme",
"keywords": [
"asset-distribution",
"asset-streaming",
"blockchain",
"cryptoasset-streaming",
Expand All @@ -38,7 +39,11 @@
"sablier-v2",
"smart-contracts",
"solidity",
"token-streaming"
"token-distribution",
"token-streaming",
"token-vesting",
"vesting",
"web3"
],
"peerDependencies": {
"@prb/math": "4.0.1"
Expand Down

0 comments on commit 0f6c141

Please sign in to comment.