diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..f32b51196 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +Release notes and version history for flow are tracked via GitHub Releases: + +- https://github.com/onflow/flow/releases + +For user-facing changes per version, see the Releases page. diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 000000000..e40500660 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,19 @@ +cff-version: 1.2.0 +message: "If you use flow in your research or reference it, please cite it as below." +title: "flow: Central hub for the Flow network — protocol specs, interface definitions, and governance" +authors: + - name: "Flow Foundation" + website: "https://flow.com" +repository-code: "https://github.com/onflow/flow" +url: "https://flow.com" +license: Apache-2.0 +type: software +keywords: + - flow + - flow-network + - blockchain + - layer-1 + - proof-of-stake + - cadence + - smart-contracts + - protocol diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..f0959dc33 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing to flow + +Thank you for your interest in contributing to the Flow network. This repository hosts protocol specifications, interface definitions (protobuf and OpenAPI), node operator docs, governance agendas, and the mainnet spork history. + +## Ways to contribute + +- **Protocol improvements**: open a [Flow Improvement Proposal (FLIP)](https://github.com/onflow/flips) for substantive protocol or standard changes. +- **Interface definitions**: suggest updates to the protobuf schema (`protobuf/`) or the Access API OpenAPI specification (`openapi/`) by opening a pull request. +- **Node operator docs**: improvements to the `nodeoperators/` directory are welcome. +- **Spork records**: corrections to `sporks.json` should reference the upstream source for the change. + +## Workflow + +1. Fork this repository and create a branch from `master`. +2. Make your change, keeping commits focused and well-described. +3. Open a pull request describing the motivation and the scope of the change. +4. Respond to review feedback. Maintainers may ask for adjustments or request that larger changes go through the FLIP process. + +## Code of conduct + +All contributors are expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md). + +## Security + +Please do not file public issues for security vulnerabilities. See [SECURITY.md](SECURITY.md) for responsible disclosure instructions. + +## Community + +- [Flow Discord](https://discord.gg/flow) +- [Flow Forum](https://forum.flow.com) +- [Flow Improvement Proposals](https://github.com/onflow/flips) diff --git a/README.md b/README.md index ec4d88345..815e1894f 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,81 @@ -# [Flow](https://www.flow.com) +# flow — The Flow Network -Flow is a fast, secure, and developer-friendly blockchain built to support the next generation of games, apps, and the digital assets that power them. +[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE) +[![Release](https://img.shields.io/github/v/release/onflow/flow?include_prereleases)](https://github.com/onflow/flow/releases) +[![Discord](https://img.shields.io/badge/discord-flow-5865F2?logo=discord&logoColor=white)](https://discord.gg/flow) +[![Built on Flow](https://img.shields.io/badge/built%20on-Flow-00EF8B)](https://flow.com) +[![FLIPs](https://img.shields.io/badge/governance-FLIPs-informational)](https://github.com/onflow/flips) -- For a high-level overview of Flow's architecture, check out the [primer](https://www.flow.com/primer). -- Details about the protocol can be found in the [technical papers](https://www.flow.com/technical-paper). -- For more documentation and tutorials, check out [developer portal](https://developers.flow.com). +Flow is a Layer 1 proof-of-stake blockchain built for consumer applications, AI Agents, and DeFi at scale. This repository is the central hub for the Flow network: protocol specifications, interface definitions, node operator documentation, governance agendas, and the historical record of mainnet sporks. -Find out more about Flow Improvement Proposals (FLIPs) in [Flow FLIPs](https://github.com/onflow/flips) \ No newline at end of file +## TL;DR + +- **What:** Central metadata repository for the Flow network — specs, protobuf and OpenAPI interfaces, node operator docs, and spork history. +- **Who it's for:** Protocol contributors, node operators, integrators, and researchers referencing the Flow network. +- **Why use it:** Single source of truth for Flow interface definitions and protocol reference material. +- **Status:** see [Releases](https://github.com/onflow/flow/releases) for the latest tagged version. +- **License:** Apache-2.0. +- **Related repos:** [onflow/flips](https://github.com/onflow/flips) · [onflow/flow-go](https://github.com/onflow/flow-go) · [onflow/cadence](https://github.com/onflow/cadence) +- The reference meta-repository for the Flow network, open-sourced since 2020. + +## Overview + +- High-level overview of the Flow protocol: [Flow primer](https://www.flow.com/primer). +- In-depth technical details: [Flow technical papers](https://www.flow.com/technical-paper). +- Developer tutorials, SDKs, and API reference: [developer portal](https://developers.flow.com). +- Cadence smart contract language: [cadence-lang.org](https://cadence-lang.org). + +## What is in this repository + +| Path | Contents | +|------|----------| +| [`protobuf/`](./protobuf) | Flow protobuf schema and generated Go bindings, plus Gradle tooling for other languages. See [`protobuf/README.md`](./protobuf/README.md). | +| [`openapi/`](./openapi) | OpenAPI definitions for the Flow Access API REST surface. See [`openapi/README.md`](./openapi/README.md). | +| [`specs/`](./specs) | Protocol specifications, including the access node architecture. | +| [`flips/`](./flips) | Historical FLIPs tracked in this repo. New FLIPs are proposed at [onflow/flips](https://github.com/onflow/flips). | +| [`nodeoperators/`](./nodeoperators) | Reference material for running Flow nodes. | +| [`agendas/`](./agendas) | Meeting agendas and notes for protocol and community working groups. | +| [`docs/`](./docs) | Long-form documentation tracked in this repo. | +| [`sporks.json`](./sporks.json) | Machine-readable record of all Flow mainnet and testnet sporks, including access endpoints, root heights, and protocol versions. | + +## Flow Improvement Proposals + +New protocol, standards, and tooling proposals are handled through the Flow Improvement Proposal (FLIP) process. Open new FLIPs at [github.com/onflow/flips](https://github.com/onflow/flips). + +## FAQ + +**What is the Flow network?** +Flow is a Layer 1 proof-of-stake blockchain designed for consumer applications, AI Agents, and DeFi at scale. See the [primer](https://www.flow.com/primer) for a high-level overview. + +**What is in this repository versus `onflow/flow-go`?** +This repository hosts protocol specifications, interface definitions, and governance metadata. [`onflow/flow-go`](https://github.com/onflow/flow-go) hosts the reference Go implementation of the Flow protocol. + +**Where do I go for developer documentation?** +The [Flow developer portal](https://developers.flow.com) covers SDKs, tutorials, and API references. Cadence-specific documentation is on [cadence-lang.org](https://cadence-lang.org). + +**Where do I propose a protocol change?** +Open a Flow Improvement Proposal at [github.com/onflow/flips](https://github.com/onflow/flips). + +**What is `sporks.json` used for?** +`sporks.json` is a machine-readable record of all Flow mainnet and testnet sporks. Tooling and SDKs use it to look up network endpoints and protocol versions. + +**How do I generate Flow protobuf client bindings?** +See [`protobuf/README.md`](./protobuf/README.md) for generation instructions using buf and the included Gradle tooling. + +**How do I report a security vulnerability?** +See [SECURITY.md](SECURITY.md) for responsible disclosure instructions. Do not file public issues for security vulnerabilities. + +## Community + +- [Flow Discord](https://discord.gg/flow) +- [Flow Forum](https://forum.flow.com) +- [Flow Improvement Proposals](https://github.com/onflow/flips) + +## About Flow + +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. + +- Developer docs: https://developers.flow.com +- Cadence language: https://cadence-lang.org +- Community: [Flow Discord](https://discord.gg/flow) · [Flow Forum](https://forum.flow.com) +- Governance: [Flow Improvement Proposals](https://github.com/onflow/flips)