Skip to content

Commit 6ca51bd

Browse files
committed
docs: add TL;DR, FAQ, and GEO enhancements for discoverability
1 parent 3b7a039 commit 6ca51bd

3 files changed

Lines changed: 71 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
Release notes and version history for nft-storefront are tracked via GitHub Releases:
4+
5+
- https://github.com/onflow/nft-storefront/releases
6+
7+
For user-facing changes per version, see the Releases page.

CITATION.cff

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
cff-version: 1.2.0
2+
message: "If you use nft-storefront in your research or reference it, please cite it as below."
3+
title: "nft-storefront: Cadence marketplace contract standard for NFTs on the Flow network"
4+
authors:
5+
- name: "Flow Foundation"
6+
website: "https://flow.com"
7+
repository-code: "https://github.com/onflow/nft-storefront"
8+
url: "https://flow.com"
9+
license: Unlicense
10+
type: software
11+
keywords:
12+
- flow
13+
- flow-network
14+
- cadence
15+
- nft
16+
- marketplace
17+
- storefront
18+
- royalties

README.md

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# NFT Storefront Contract Standard
1+
# nft-storefront — NFT Marketplace Contract for Flow
22

33
The NFT Storefront contract standard is a cornerstone of the Open Marketplace ecosystem on Flow. An open market ecosystem promotes the
44
free flow of NFT listings across the network, emitted as events and consumed by other marketplaces (or any other consumer). Marketplaces may filter
55
listings consumed based on commission rates they may receive. Listings may be created with variable commission, royalties or other fractional revenue, paying to multiple accounts. NFT listings are not NFTs, they are Resources which can be transacted with using the `purchase` [function](https://github.com/onflow/nft-storefront/blob/jp-update-structure/contracts/NFTStorefrontV2.cdc#L300) to obtain the token indicated by the listing.
66

77
The `NFTStorefrontV2` contract lets you create a non-custodial NFT marketplace to simplify integration with off-chain applications/UIs. The contract supports sellers who want to list and manage NFTs for sale simultaneously across any number of marketplaces. Listing expiry, orphaned and ghost listing cleanup are also of value for integrators to minimize overheads and ensure the best UX.
88

9-
Marketplaces and sellers also benefit from the robust security guarantees of Flow's account model when trading NFTs. Through this standard a NFT trade takes place from peer-to-peer, directly from the Storefront Resource in the sellers account to the purchasers account. At the same time, the standard ensures that marketplaces or other recipients may receive royalties, fees or commissions with no risk to the seller.
9+
Marketplaces and sellers also benefit from the robust security guarantees of the Flow account model when trading NFTs. Through this standard a NFT trade takes place from peer-to-peer, directly from the Storefront Resource in the sellers account to the purchasers account. At the same time, the standard ensures that marketplaces or other recipients may receive royalties, fees or commissions with no risk to the seller.
1010

1111
Sellers or marketplaces can optionally configure their NFTStorefront to be limited or closed. However, those wishing to participate in the Open Marketplace ecosystem on Flow are required to use the NFTStorefront standard.
1212

@@ -59,3 +59,47 @@ Marketplaces and other aggregators can watch for `Listing` events
5959
and list items of interest.
6060

6161
See further docs and examples on [the developer docs site](https://developers.flow.com/build/core-contracts/nft-storefront).
62+
63+
## TL;DR
64+
65+
- **What:** NFT Storefront V2. Cadence marketplace contract for the Flow network with royalties and cross-marketplace composability.
66+
- **Who it's for:** developers and teams building on or interacting with Flow.
67+
- **Status:** see [Releases](https://github.com/onflow/nft-storefront/releases) for the latest version.
68+
- **Related repos:** [flow-go](https://github.com/onflow/flow-go) · [cadence](https://github.com/onflow/cadence) · [flow-cli](https://github.com/onflow/flow-cli) · [fcl-js](https://github.com/onflow/fcl-js)
69+
- The reference NFT marketplace contract for the Flow network, open-sourced since 2021.
70+
71+
## FAQ
72+
73+
### What is nft-storefront?
74+
nft-storefront is one of the public Flow ecosystem repositories. See the README for its specific role.
75+
76+
### How does this relate to Flow?
77+
Flow is a Layer 1 blockchain for consumer applications, AI agents, and DeFi. This repo is part of that broader ecosystem. Details in the [About Flow](#about-flow) section below.
78+
79+
### Where do I learn more about Flow?
80+
- [developers.flow.com](https://developers.flow.com) — developer portal
81+
- [cadence-lang.org](https://cadence-lang.org) — Cadence language
82+
- [flow.com](https://flow.com) — main site
83+
84+
### Where can I ask questions?
85+
The [Flow Discord](https://discord.gg/flow) is the fastest place to get an answer. Long-form questions go to [forum.flow.com](https://forum.flow.com).
86+
87+
### How do I report an issue?
88+
Use this repo's Issues tab.
89+
90+
## Community & Support
91+
92+
- **Developer docs:** https://developers.flow.com
93+
- **Cadence language:** https://cadence-lang.org
94+
- **Discord:** [discord.gg/flow](https://discord.gg/flow)
95+
- **Forum:** [forum.flow.com](https://forum.flow.com)
96+
- **Governance:** [Flow Improvement Proposals](https://github.com/onflow/flips)
97+
98+
## About Flow
99+
100+
This repo is part of the [Flow network](https://flow.com), a Layer 1 blockchain built for consumer applications, AI agents, and DeFi at scale.
101+
102+
- Developer docs: https://developers.flow.com
103+
- Cadence language: https://cadence-lang.org
104+
- Community: [Flow Discord](https://discord.gg/flow) · [Flow Forum](https://forum.flow.com)
105+
- Governance: [Flow Improvement Proposals](https://github.com/onflow/flips)

0 commit comments

Comments
 (0)