Merge pull request #99 from morpho-org/docs/readme

Readme and fix license
morpho-org · Dec 1, 2023 · 6692ede · 6692ede
2 parents c2b1732 + 3a3b8cf
commit 6692ede
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 7 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2023 Morpho Labs
+Copyright (c) 2023 Morpho Association
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

diff --git a/README.md b/README.md
@@ -1,5 +1,23 @@
-# Morpho Blue IRM
+# Morpho Blue IRMs
+
+Some interest rate models for Morpho Blue:
+
+- [AdaptiveCurveIRM](src/AdaptiveCurveIrm.sol)
+
+## Resources
+
+- AdaptiveCurveIRM: [documentation](https://www.notion.so/morpho-labs/Morpho-Blue-Documentation-Hub-External-00ff8194791045deb522821be46abbdc?pvs=4#d8269074bfd649009f28625a9caa38ea), [announcement article](https://morpho.mirror.xyz/aaUjIF85aIi5RT6-pLhVWBzuiCpOb4BV03OYNts2BHQ).
 
 ## Audits
 
-All audits are stored in the [audits](./audits/)' folder.
+All audits are stored in the [audits](audits)' folder.
+
+## Getting started
+
+Install dependencies: `forge install`
+
+Run tests: `forge test`
+
+## Licenses
+
+The primary license is MIT, see [LICENSE](LICENSE).
diff --git a/test/AdaptiveCurveIrmTest.sol b/test/AdaptiveCurveIrmTest.sol
@@ -24,8 +24,9 @@ contract AdaptiveCurveIrmTest is Test {
     MarketParams internal marketParams = MarketParams(address(0), address(0), address(0), address(0), 0);
 
     function setUp() public {
-        irm =
-        new AdaptiveCurveIrm(address(this), CURVE_STEEPNESS, ADJUSTMENT_SPEED, TARGET_UTILIZATION, INITIAL_RATE_AT_TARGET);
+        irm = new AdaptiveCurveIrm(
+            address(this), CURVE_STEEPNESS, ADJUSTMENT_SPEED, TARGET_UTILIZATION, INITIAL_RATE_AT_TARGET
+        );
         vm.warp(90 days);
 
         bytes4[] memory selectors = new bytes4[](1);
@@ -187,8 +188,9 @@ contract AdaptiveCurveIrmTest is Test {
     function testRateAfter3WeeksUtilizationTargetPingEveryMinute() public {
         int256 initialRateAtTarget = int256(1 ether) / 365 days; // 100%
 
-        irm =
-        new AdaptiveCurveIrm(address(this), CURVE_STEEPNESS, ADJUSTMENT_SPEED, TARGET_UTILIZATION, initialRateAtTarget);
+        irm = new AdaptiveCurveIrm(
+            address(this), CURVE_STEEPNESS, ADJUSTMENT_SPEED, TARGET_UTILIZATION, initialRateAtTarget
+        );
 
         Market memory market;
         market.totalSupplyAssets = 1 ether;