Skip to content

Commit 1810308

Browse files
authored
docs: add TL;DR, FAQ, and GEO enhancements for discoverability (#2806)
* docs: apply SEO/GEO audit recommendations * docs: add AGENTS.md Adds the AGENTS.md open-standard file for AI coding agents. Every claim evidence-backed against Makefile, package.json, source tree, or equivalent manifest. Zero fabrication.
1 parent f91cec6 commit 1810308

3 files changed

Lines changed: 89 additions & 17 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 fcl-js are tracked via GitHub Releases:
4+
5+
- https://github.com/onflow/fcl-js/releases
6+
7+
For user-facing changes per version, see the Releases page.

‎CITATION.cff‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
cff-version: 1.2.0
2+
message: "If you use fcl-js in your research or reference it, please cite it as below."
3+
title: "fcl-js: Flow Client Library for JavaScript and TypeScript"
4+
authors:
5+
- name: "Flow Foundation"
6+
website: "https://flow.com"
7+
repository-code: "https://github.com/onflow/fcl-js"
8+
url: "https://flow.com"
9+
license: Apache-2.0
10+
type: software
11+
keywords:
12+
- flow
13+
- flow-network
14+
- fcl
15+
- flow-client-library
16+
- typescript
17+
- javascript
18+
- sdk
19+
- wallet-authentication
20+
- dapp
21+
- cadence

‎README.md‎

Lines changed: 61 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,38 @@
1+
# fcl-js — Flow Client Library for JavaScript and TypeScript
2+
3+
[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](./LICENSE)
4+
[![Release](https://img.shields.io/github/v/release/onflow/fcl-js?include_prereleases&sort=semver)](https://github.com/onflow/fcl-js/releases)
5+
[![Discord](https://img.shields.io/discord/613813861610684416?label=Discord&logo=discord&logoColor=white)](https://discord.gg/flow)
6+
[![Built on Flow](https://img.shields.io/badge/Built%20on-Flow-00EF8B?logo=flow)](https://flow.com)
7+
[![npm (@onflow/fcl)](https://img.shields.io/npm/v/@onflow/fcl.svg?label=%40onflow%2Ffcl)](https://www.npmjs.com/package/@onflow/fcl)
8+
19
[![FLOW-JS-SDK Continuous Integration](https://github.com/onflow/flow-js-sdk/actions/workflows/integrate.yml/badge.svg)](https://github.com/onflow/flow-js-sdk/actions/workflows/integrate.yml)
210
[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
311

4-
<br />
5-
<br />
612
<p align="center">
7-
<h1 align="center"> FCL JS</h1>
8-
<p align="center">
9-
<i>Connect your dapp to users, their wallets and Flow.</i>
10-
<br />
11-
<br />
12-
<a href="https://developers.flow.com/tutorials/flow-app-quickstart">Quickstart</a>
13-
·
14-
<a href="https://github.com/onflow/fcl-js/issues">Report Bug</a>
15-
·
16-
<a href="https://github.com/onflow/fcl-js/blob/master/CONTRIBUTING.md">Contribute</a>
17-
18-
</p>
13+
<i>Connect your dapp to users, their wallets and Flow.</i>
14+
<br />
15+
<br />
16+
<a href="https://developers.flow.com/tutorials/flow-app-quickstart">Quickstart</a>
17+
·
18+
<a href="https://github.com/onflow/fcl-js/issues">Report Bug</a>
19+
·
20+
<a href="https://github.com/onflow/fcl-js/blob/master/CONTRIBUTING.md">Contribute</a>
1921
</p>
2022

23+
## TL;DR
24+
25+
- **What:** FCL (Flow Client Library) in TypeScript and JavaScript. Connect Flow dApps to wallets, send transactions, and read on-chain data from the browser.
26+
- **Who it's for:** JavaScript and TypeScript developers building dApps, wallets, and tools on Flow.
27+
- **Why use it:** Standardized wallet discovery and authentication, Cadence script and transaction execution, and a flexible runtime that works in browser and server environments.
28+
- **Status:** see [Releases](https://github.com/onflow/fcl-js/releases) for the latest version.
29+
- **License:** Apache-2.0.
30+
- **Related repos:** [onflow/flow-go-sdk](https://github.com/onflow/flow-go-sdk) · [onflow/fcl-discovery](https://github.com/onflow/fcl-discovery) · [onflow/fcl-dev-wallet](https://github.com/onflow/fcl-dev-wallet)
31+
- The reference JavaScript/TypeScript client library for the Flow network, open-sourced since 2020.
32+
2133
## 🌟 What is FCL?
2234

23-
The **Flow Client Library (FCL) JS** is a package designed to facilitate interactions between dapps, wallets, and the Flow blockchain. It provides a standardized way for applications to connect with users and their wallets, **eliminating the need for custom integrations**.
35+
The **Flow Client Library (FCL) JS** is a package designed to facilitate interactions between dapps, wallets, and the Flow network. It provides a standardized way for applications to connect with users and their wallets, **eliminating the need for custom integrations**.
2436

2537
### 🔑 Key Features:
2638
- 🔌 **Universal Wallet Support** – Works seamlessly with all FCL-compatible wallets, making authentication simple.
@@ -158,7 +170,7 @@ For all type definitions available, see [this file](./packages/typedefs/src/inde
158170

159171
- See the [Flow App Quick Start](https://developers.flow.com/build/getting-started/fcl-quickstart).
160172
- See the full [API Reference](https://developers.flow.com/tools/clients/fcl-js/api) for all FCL functionality.
161-
- Learn Flow's smart contract language to build any script or transactions: [Cadence](https://cadence-lang.org).
173+
- Learn Cadence — the smart contract language for Flow — to build scripts and transactions: [Cadence](https://cadence-lang.org).
162174
- Explore all of Flow [docs and tools](https://developers.flow.com).
163175

164176
## Development & Testing
@@ -222,7 +234,7 @@ The discovery feature can be used via API allowing you to customize your own UI
222234

223235
## 🛠 Want to Use the Flow SDK Directly?
224236

225-
If you prefer to interact with Flow at a **lower level** without using FCL, you can use the [Flow JavaScript SDK](packages/sdk/readme.md) directly. The SDK provides raw access to Flow's API for sending transactions, executing scripts, and managing accounts.
237+
If you prefer to interact with Flow at a **lower level** without using FCL, you can use the [Flow JavaScript SDK](packages/sdk/readme.md) directly. The SDK provides raw access to the Flow Access API for sending transactions, executing scripts, and managing accounts.
226238

227239
FCL is built **on top of the Flow SDK**, making it easier to handle authentication, wallet interactions, and dapp connectivity. Choose the approach that best fits your use case.
228240

@@ -231,3 +243,35 @@ FCL is built **on top of the Flow SDK**, making it easier to handle authenticati
231243
- Notice a problem or want to request a feature? [Add an issue](https://github.com/onflow/fcl-js/issues).
232244
- Join the Flow community on [Discord](https://discord.gg/flow) to keep up to date and to talk to the team.
233245
- Read the [Contributing Guide](./CONTRIBUTING.md) to learn how to contribute to the project.
246+
247+
## FAQ
248+
249+
**What is FCL?**
250+
FCL (Flow Client Library) is a JavaScript and TypeScript package that standardizes how dApps connect to wallets and interact with the Flow network. It handles wallet discovery, authentication, transaction signing, and Cadence script execution.
251+
252+
**How is FCL different from the Flow JavaScript SDK?**
253+
FCL is built on top of the Flow JavaScript SDK (`@onflow/sdk`). FCL adds wallet interactions, discovery, and higher-level helpers. If you prefer to interact with Flow at a lower level without wallet integrations, you can use the SDK directly.
254+
255+
**Which environments does FCL run in?**
256+
FCL can run in both browser and server environments. Wallet interactions are browser-only; server-side usage is supported for queries, transactions signed with custom authorizers, and account utilities.
257+
258+
**Does FCL support TypeScript?**
259+
Yes. Types are available in the [`@onflow/typedefs`](./packages/typedefs) package and exported from the main FCL packages.
260+
261+
**What wallets does FCL support?**
262+
FCL works with any FCL-compatible wallet, including Flow Wallet, NuFi, Blocto, Ledger, and Dapper Wallet. Discovery is provided via the [wallet discovery service](https://github.com/onflow/fcl-discovery).
263+
264+
**Can I use FCL with Flow EVM?**
265+
Yes. The repo includes adapters for [RainbowKit](./packages/fcl-rainbowkit-adapter) and [Wagmi](./packages/fcl-wagmi-adapter), plus an [EIP-1193 Ethereum provider](./packages/fcl-ethereum-provider) backed by FCL.
266+
267+
**Where do I report bugs or request features?**
268+
Open an issue at [github.com/onflow/fcl-js/issues](https://github.com/onflow/fcl-js/issues) or start a conversation on the [Flow Forum](https://forum.flow.com).
269+
270+
## About Flow
271+
272+
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.
273+
274+
- Developer docs: https://developers.flow.com
275+
- Cadence language: https://cadence-lang.org
276+
- Community: [Flow Discord](https://discord.gg/flow) · [Flow Forum](https://forum.flow.com)
277+
- Governance: [Flow Improvement Proposals](https://github.com/onflow/flips)

0 commit comments

Comments
 (0)