Merge branch 'release/1.0.0'

ferrumnet · Oct 28, 2022 · 5825dc3 · 5825dc3
2 parents 47fc3e4 + 2e8b890
commit 5825dc3
Show file tree

Hide file tree

Showing 10 changed files with 20 additions and 57 deletions.
diff --git a/README.md b/README.md
@@ -1,16 +1,15 @@
-<<<<<<< HEAD
-# Ferrum Network Linear Release Engine
-=======
 ---
 description: >-
-  Vesting done right, powered by Ferrum's Linear Release Engine. A modular
-  solution that can be used for invested, advisory, team tokens and even staking
-  or farming rewards.
+  A powerful engine enabling a per-second release rate of tokens for vesting,
+  rewards, staking, farming, and so much more.
 ---
 
 # ⚖ Linear Release Engine
 
 At Ferrum, we pride ourselves on creating solutions that add value to the industry by solving critical pain points. We've done this in the past with our staking solutions, bridging solutions, MultiSwap, and more. Now we are bringing the same methodical approach to vesting, staking rewards, and more.
 
 The Linear Release Engine helps avoid sell pressure and dump days while giving the community, investors and advisors access to tokens on a per-second basis instead of waiting for months to get access to their tokens.&#x20;
->>>>>>> cebc0fac1f5022fb526e519f30c7a3a511eb59b6
+
+{% content-ref url="introduction/audited-by-vidma.md" %}
+[audited-by-vidma.md](introduction/audited-by-vidma.md)
+{% endcontent-ref %}
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -7,8 +7,4 @@
 * [📝 Overview](introduction/overview.md)
   * [Problem and Solution](introduction/overview/problem-and-solution.md)
   * [The Linear Release Engine](introduction/overview/the-linear-release-engine.md)
-* [💰 Iron Vest](introduction/iron-vest/README.md)
-  * [Time-Based Vesting](introduction/iron-vest/time-based-vesting.md)
-  * [Linear Release with Custom Release Rates](introduction/iron-vest/linear-release-with-custom-release-rates.md)
-  * [Linear Release with a Cliff or Lock Period](introduction/iron-vest/linear-release-with-a-cliff-or-lock-period.md)
-  * [Team Token Administration](introduction/iron-vest/team-token-administration.md)
+* [🔏 Audited by Vidma](introduction/audited-by-vidma.md)
diff --git a/introduction/audited-by-vidma.md b/introduction/audited-by-vidma.md
@@ -0,0 +1,5 @@
+# 🔏 Audited by Vidma
+
+{% embed url="https://drive.google.com/file/d/1atppspahsiNsnUP0IbBZCqZ6xot2mEhL/view?usp=sharing" %}
+Ferrum Network - IRONVEST - Audit by Vidma (Oct 24, 2022)
+{% endembed %}
diff --git a/introduction/iron-vest/README.md b/introduction/iron-vest/README.md
diff --git a/introduction/iron-vest/linear-release-with-a-cliff-or-lock-period.md b/introduction/iron-vest/linear-release-with-a-cliff-or-lock-period.md
diff --git a/introduction/iron-vest/linear-release-with-custom-release-rates.md b/introduction/iron-vest/linear-release-with-custom-release-rates.md
diff --git a/introduction/iron-vest/team-token-administration.md b/introduction/iron-vest/team-token-administration.md
diff --git a/introduction/iron-vest/time-based-vesting.md b/introduction/iron-vest/time-based-vesting.md
diff --git a/introduction/overview/problem-and-solution.md b/introduction/overview/problem-and-solution.md
@@ -10,12 +10,13 @@ When you review the currently available solutions, you find one or more of the f
 2. Not providing the option for linear release, only giving option for release date based vesting
 3. Not providing the option for a cliff or lock period with the linear release option
 4. Not providing the option for linear release of the cliff or locked period tokens
-5. No ability to administer necessary updates on token categories such as team tokens
+5. No ability to administer necessary updates on token categories, such as team tokens
+6. No ability to connect linear release to reward contracts such as staking, farming, and more.
 
 With our Linear Release Engine, Ferrum has set out to solve each one of these problems and bring more value to the space.
 
 ### Our Solution - Linear Release Engine
 
-We built a modular Linear Release Engine to solve the issues identified above and to enable extensibility so the open source community and developers around the world can build their own implementations powered by Ferrum's Linear Release Engine.
+We built a modular Linear Release Engine to solve the issues identified above and to enable extensibility so the open-source community and developers around the world can build their own implementations powered by Ferrum's Linear Release Engine.
 
-Linear Release Engine makes it possible to build products like Iron Vest which can solve real-world problems with token release schedules and mitigate the sell pressure caused by staking, farming, and mining rewards or vesting token release dates.
+Linear Release Engine makes it possible to build products like Iron Vest, which can solve real-world problems with token release schedules and mitigate the sell pressure caused by staking, farming, and mining rewards or vesting token release dates.
diff --git a/introduction/overview/the-linear-release-engine.md b/introduction/overview/the-linear-release-engine.md
@@ -3,3 +3,7 @@
 ### What is the Linear Release Engine?
 
 The Linear Release Engine is a modular implementation that allows you to configure the release of ERC20 assets with limitless built-in customizations. To explain the full power of the Linear Release Engine we have created the Iron Vest product powered by the Linear Release Engine. Let's go over all the features of the Iron Vest.
+
+{% content-ref url="https://app.gitbook.com/o/4kmBmwCSGs18VyCPwcJE/s/sqX9RCXpejkUPhm0z3wi/" %}
+[Iron Vest](https://app.gitbook.com/o/4kmBmwCSGs18VyCPwcJE/s/sqX9RCXpejkUPhm0z3wi/)
+{% endcontent-ref %}