Skip to content

Commit 9a1f0aa

Browse files
committed
docs: update README formatting and instructions for clarity
1 parent 5bcecc8 commit 9a1f0aa

1 file changed

Lines changed: 16 additions & 14 deletions

File tree

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ A modular, upgradeable smart contract framework built using the [EIP-2535 Diamon
1818

1919
## 🛠️ Project Structure
2020

21-
```bash
21+
```sh
2222
.
2323
├── src/
2424
│ ├── Diamond.sol # Diamond core contract
25-
│ ├── facets/ # All facets (logic modules)
26-
│ ├── initializer/ # Initializer for setting up ERC165 and others
27-
│ ├── interfaces/ # Diamond-compliant interfaces (e.g. IDiamondCut)
28-
│ ├── libraries/ # DiamondStorage, LibDiamond, etc.
25+
│ ├── facets/ # All facets (logic modules)
26+
│ ├── initializer/ # Initializer for setting up ERC165 and others
27+
│ ├── interfaces/ # Diamond-compliant interfaces (e.g. IDiamondCut)
28+
│ ├── libraries/ # DiamondStorage, LibDiamond, etc.
2929
│ └── scripts/DeployDiamond.s.sol # Foundry deployment script
3030
3131
├── test/
@@ -37,27 +37,29 @@ A modular, upgradeable smart contract framework built using the [EIP-2535 Diamon
3737

3838
## 🚀 Getting Started
3939

40-
1. Install Dependencies
40+
1. Forge install this repo
4141

42-
```bash
43-
forge install
42+
```sh
43+
forge install DADADAVE80/diamond-template
4444
```
4545

46-
2. Compile
47-
48-
```bash
49-
forge build
46+
2. Import the Diamond contract and facets into your project
47+
```solidity
48+
import {Diamond} from "@diamond/Diamond.sol";
49+
import {DiamondCutFacet} from "@diamond/facets/DiamondCutFacet.sol";
50+
import {DiamondLoupeFacet} from "@diamond/facets/DiamondLoupeFacet.sol";
51+
import {OwnableRolesFacet} from "@diamond/facets/OwnableRolesFacet.sol";
5052
```
5153

5254
3. Run Tests
5355

54-
```bash
56+
```sh
5557
forge test --ffi -vvv
5658
```
5759

5860
4. Deploy Locally
5961

60-
```bash
62+
```sh
6163
forge script script/DeployDiamond.s.sol --fork-url <RPC_URL> --broadcast
6264
```
6365

0 commit comments

Comments
 (0)