Skip to content

Commit 8fd8cf4

Browse files
committed
Update readme file
1 parent 16a5409 commit 8fd8cf4

File tree

3 files changed

+36
-1
lines changed

3 files changed

+36
-1
lines changed

Diff for: LICENCE.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright 2022 Abstract Labs, Inc.
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Diff for: README.md

+29-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,29 @@
1-
# 0x-propery-validators
1+
![Hook](img/hook-protocol-banner.png)
2+
3+
## Hook 0x Property Validator
4+
5+
Hook uses the property validator interface from 0x (`IPropertyValidator.sol`) to enable propertyData to be used in orders.
6+
7+
## Setup
8+
9+
This repository utilizes Foundry for test suites and
10+
`forge install` to install dependencies from git submodules
11+
12+
## Contract Addresses
13+
14+
[ TODO: Update contract addresses with the mainnet deployment ]
15+
16+
## Testing
17+
18+
`forge test` to run all forge tests\
19+
`forge test --match-contract <Test Contract Name>` to run tests on a specific contract
20+
21+
## Additional Foundry Info
22+
23+
[Foundry](https://github.com/foundry-rs/foundry)
24+
25+
[Foundry Book](https://book.getfoundry.sh)
26+
27+
## Licence
28+
29+
[MIT](LICENCE.md) Copyright 2022 Abstract Labs, Inc.

Diff for: img/hook-protocol-banner.png

318 KB
Loading

0 commit comments

Comments
 (0)