Skip to content

Commit a91832a

Browse files
authored
updated docs to point to github pages (ourzora#438)
* updated docs to point to github pages * added a status badge
1 parent 7297b4e commit a91832a

File tree

3 files changed

+5
-428
lines changed

3 files changed

+5
-428
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Zora Protocol
22

3+
[![Contracts](https://github.com/ourzora/zora-protocol/actions/workflows/contracts.yml/badge.svg)](https://github.com/ourzora/zora-protocol/actions/workflows/contracts.yml)
4+
35
This repository is a monorepo for the Zora Protocol
46

57
In it you will find:
@@ -45,4 +47,3 @@ Run in development mode (watch tests):
4547
## Development workflow
4648

4749
See [DEVELOPING.md](./DEVELOPING.md)
48-
Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,5 @@
11
# Zora Protocol Deployments
22

3-
Published package containing a bundle of deployed addresses and versions for the Zora Protocol.
3+
Published package containing a bundle of deployed abis and addresses for the Zora Protocol.
44

5-
## npm package usage
6-
7-
Import abis and addresses for a contract from the package:
8-
9-
```typescript
10-
import { zoraCreator1155FactoryImplConfig } from "@zoralabs/protocol-deployments";
11-
12-
// get addresses and abi for the zora creator 1155 factory:
13-
const { addresses, abi } = zoraCreator1155FactoryImplConfig;
14-
```
5+
For documentation and guides, [head to the documentation site.](https://ourzora.github.io/zora-protocol/protocol-deployments/guide)

0 commit comments

Comments
 (0)