From 140a8de241d4a78b307f0b6a03688c6395155d18 Mon Sep 17 00:00:00 2001 From: jordydutch Date: Mon, 21 Apr 2025 00:30:49 +0200 Subject: [PATCH] Add docs website to github readme --- README.md | 5 +++++ audits/README.md | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ca927a5..28e3dba 100755 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ Repository for the Stakingverse contracts. This repository includes the followin | SLYX Token Implementation | [`0x08b28405A11348745A3187De2A29C730C53EB29B`](https://explorer.lukso.network/address/0x08b28405A11348745A3187De2A29C730C53EB29B?tab=contract) | - [Stakingverse Contracts](#stakingverse-contracts) + - [Documentation](#documentation) - [Installation](#installation) - [Build](#build) - [Tests](#tests) @@ -31,6 +32,10 @@ Repository for the Stakingverse contracts. This repository includes the followin - [Audits](#audits) - [Development \& Testing](#development--testing) +## Documentation + +For comprehensive documentation about Stakingverse, please visit our [documentation website](https://docs.stakingverse.io). The documentation includes detailed information for both users and developers integrating with our platform. + ## Installation ```bash diff --git a/audits/README.md b/audits/README.md index f779c9b..0b0421f 100644 --- a/audits/README.md +++ b/audits/README.md @@ -22,4 +22,4 @@ Previous audits for this Vault contract can be found in the [UniversalPage contr
-- [Nethermind AI Agent Audit](nethermind-ai-agent-audit-report-stakingverse-pool-contracts.pdf) - Audit of both StakingverseVault.sol and Liquid Staking contracts by the BETA version of the [Nethermind](https://www.nethermind.io) Audit Agent. Check the overview of the findings [here](nethermind-findings.md). \ No newline at end of file +- [Nethermind AI Agent Audit](nethermind-ai-agent-audit-report-stakingverse-pool-contracts.pdf) - Audit of both StakingverseVault.sol and Liquid Staking contracts by the [Nethermind](https://www.nethermind.io) Audit Agent. Check the overview of the findings [here](nethermind-findings.md). \ No newline at end of file