From 02af241c3bd3e84c24f1f7f04fe170dca3d7daba Mon Sep 17 00:00:00 2001
From: PoisonPhang <17688291+PoisonPhang@users.noreply.github.com>
Date: Tue, 22 Feb 2022 19:33:35 -0600
Subject: [PATCH] Updated Crowdloan Readme

---
 frame/crowdloan-rewards/README.md | 41 ++++++++++++++++++++++---------
 1 file changed, 29 insertions(+), 12 deletions(-)

diff --git a/frame/crowdloan-rewards/README.md b/frame/crowdloan-rewards/README.md
index ac9de77a963..1ee580b8dea 100644
--- a/frame/crowdloan-rewards/README.md
+++ b/frame/crowdloan-rewards/README.md
@@ -1,18 +1,35 @@
 # Crowdloan Rewards
 
-This pallet allow contributors to claim their rewards.
+The Crowdloan Rewards pallet allows contributors to claim their rewards.
 
-A % of the reward is paid at the first claim, and the remaining % is vested over an arbitrary period splitted in windows `VestingPartition`.
+## Rewards
 
-Rewards are claiming using the following scheme.
+A percentage of the reward is paid at the first claim, and the remaining 
+percentage is vested over an arbitrary period of time split into
+`VestingPartition`s.
 
-1. An `AdminOrigin` setup the reward accounts, consisting of a vector of triple (PublicKey, Amount, VestingPeriod)
-   The PublicKey is either comming from the relay chain (Kusama in this case) or from ETH.
-2. Since the users don't own any funds on Picasso, the first claim has to be made using our service so that we sign the `associate` transaction using Composable `AssociationOrigin`.
-   The first claim result in the Picasso account being associated with the reward account.
-   Also, this association automatically trigger a claim, resulting in the first payment done (fixed % if first claim, vested amount otherwise) to the newly associated Picasso account.
-3. Once the first claim has been made, the user has to wait until the next `VestingPartition` (probably 1 week).
-   After having waited for the vesting partition. The user is able to either `associate` a new account or directly `claim` using it's already associated Picasso account.
-   This can be repeated until the contributor has claimed all its reward.
+Rewards are claimed using the following steps:
 
-Note: both `associate` and `claim` calls are not charging fees if successful.
+1. An `AdminOrigin` sets up the reward accounts, consisting of a vector of 
+   (PublicKey, Amount, VestingPeriod).  
+   The PublicKey is either comming from the relay chain (Kusama in this case) or
+   from ETH.
+
+2. Since the users don't own any funds on Picasso, the first claim has to be 
+   made using our service so that we sign the `associate` transaction using 
+   Composable's `AssociationOrigin`.  
+   The first claim results in the Picasso account being associated with the 
+   reward account. This association automatically triggers a claim, the claim 
+   results in the first payment being distributed to the newly associated 
+   Picasso account.
+
+3. Once the first claim has been made, the user has to wait until the next 
+   `VestingPartition`.  
+   After having waited for the vesting partition. The user is able to either 
+   `associate` a new account or directly `claim` using their already associated 
+   Picasso account.  
+   This can be repeated until the contributor has claimed all of their reward.
+
+## Notes
+
+* both `associate` and `claim` calls do not charge fees if successful.