Skip to content

Commit 5d34c94

Browse files
committed
updated readme
1 parent 457e57f commit 5d34c94

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,12 @@
1010
The library consists of modules and utilities that are built with a help of [Openzeppelin Contracts](https://github.com/OpenZeppelin/openzeppelin-contracts) (4.9.5) and **go far beyond mediocre solidity**.
1111

1212
- Implementation of [**Contracts Registry**](https://eips.ethereum.org/EIPS/eip-6224) pattern
13-
- Versatile **RBAC** and **MultiOwnable** smart contracts
13+
- Versatile access control smart contracts (Merkle whitelists, RBAC)
1414
- Enhanced and simplified [**Diamond**](https://eips.ethereum.org/EIPS/eip-2535) pattern
15-
- Heap based priority queue library
16-
- Memory data structures (Vector)
17-
- Optimized [**Incremental Merkle Tree**](https://github.com/runtimeverification/deposit-contract-verification/blob/master/deposit-contract-verification.pdf) data structure
18-
- Novel **ReturnDataProxy** contract
19-
- Lightweight **SBT** implementation
20-
- Flexible UniswapV2 and UniswapV3 oracles
15+
- Advanced data structures (**Vector**, **PriorityQueue**)
16+
- ZK-friendly [**Incremental Merkle Tree**](https://github.com/runtimeverification/deposit-contract-verification/blob/master/deposit-contract-verification.pdf) implementation
17+
- Flexible finance primitives (**Staking**, **Vesting**)
18+
- Easy UniswapV2 and UniswapV3 oracles
2119
- Utilities to ease work with ERC20 decimals, arrays, sets and ZK proofs
2220

2321
## Overview
@@ -30,9 +28,13 @@ $ npm install @solarity/solidity-lib
3028

3129
The latest stable version is always in the `master` branch.
3230

31+
### Documentation
32+
33+
Check out the project's [documentation](https://docs.solarity.dev) with broad explanations and usage examples of every module. Full `natspec` guides are also available in the source code.
34+
3335
## Usage
3436

35-
You will find the smart contracts in the `/contracts` directory. Feel free to play around and check the source code, it is rather descriptive.
37+
You will find the smart contracts in the `/contracts` directory. Feel free to play around and check the project's structure.
3638

3739
Once the [npm package](https://www.npmjs.com/package/@solarity/solidity-lib) is installed, one can use the library just like that:
3840

@@ -49,6 +51,10 @@ contract ContractsRegistry is OwnableContractsRegistry {
4951
> [!IMPORTANT]
5052
> It is important to use the library as it is shipped and not copy-paste the code from untrusted sources.
5153
54+
## Contribution
55+
56+
We are open to any mind-blowing ideas! Please take a look at our [contribution guidelines](https://docs.solarity.dev/docs/getting-started/contribution/how-to-contribute) to get involved.
57+
5258
## License
5359

5460
The library is released under the MIT License.

0 commit comments

Comments
 (0)