Skip to content

Commit 78bbd9f

Browse files
authored
Merge pull request #7 from IndexCoop/update-readme-audits
Update README
2 parents bc44830 + a6403ab commit 78bbd9f

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
[![CircleCI](https://dl.circleci.com/status-badge/img/gh/IndexCoop/index-protocol/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/IndexCoop/index-protocol/tree/master)
22
[![Coverage Status](https://coveralls.io/repos/github/IndexCoop/index-protocol/badge.svg?branch=master)](https://coveralls.io/github/IndexCoop/index-protocol?branch=master)
33

4-
# Set Protocol V2 Contract Repository
4+
# Index Protocol Contract Repository
5+
6+
An overview of Index Protocol is available in our [Gitbook docs][11]
7+
8+
[11]: https://index-coop.gitbook.io/index-coop-community-handbook/protocols/index-protocol
59

610
## Contracts
7-
Repo originally forked from [Set Protocol v2](https://github.com/indexcoop/index-protocol) with approval from Set Labs. This repo is intended to house both original code (including most of this README) *and* new code that extends the protocol.
11+
This repo was originally forked from [Set Protocol v2](https://github.com/indexcoop/index-protocol) with permission from Set Labs. It is intended to house both original code (including most of this README) *and* new code that extends the protocol. Not all of the original contracts will be deployed as part of Index Protocol, and in time we will clean up unused code.
812

913
[Set Protocol](https://setprotocol.com/) is a specification for tokenized asset management strategies on the ethereum blockchain written in the Solidity programming language. We use [Hardhat](https://hardhat.org/) as a development environment for compiling, testing, and deploying our contracts.
1014

@@ -78,21 +82,14 @@ description):
7882

7983

8084
## Contributing
81-
We highly encourage participation from the community to help shape the development of Set. If you are interested in developing on top of Set Protocol or have any questions, please ping us on [Discord](https://discord.gg/ZWY66aR).
82-
83-
## Security
84-
85-
### TODO: Independent Audits
86-
87-
### Code Coverage
85+
We encourage participation from the community to help shape the development of Index Protocol. If you are interested in developing on top of Set Protocol or have any questions, please ping us on [Discord](https://discord.gg/ZWY66aR).
8886

89-
All smart contracts are tested and have 100% line and branch coverage.
87+
## Security Audits
9088

91-
### Vulnerability Disclosure Policy
89+
Set Protocol V2 has undergone several audits. For more information see https://index-coop.gitbook.io/index-coop-community-handbook/protocols/security-and-audits
9290

93-
The disclosure of security vulnerabilities helps us ensure the security of our users.
91+
## Vulnerability Reporting ##
9492

95-
**How to report a security vulnerability?**
93+
If you believe you’ve found a security vulnerability in one of our contracts or platforms, we encourage you to submit it through our [ImmuneFi Bug Bounty][32] program.
9694

97-
If you believe you’ve found a security vulnerability in one of our contracts or platforms,
98-
please refer to our [ImmuneFi Bug Bounty](https://immunefi.com/bounty/indexcoop/).
95+
[32]: https://immunefi.com/bounty/indexcoop/

0 commit comments

Comments
 (0)