You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 1810308
Browse filesBrowse the repository at this point in the historyBrowse files
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.
-**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.
- The reference JavaScript/TypeScript client library for the Flow network, open-sourced since 2020.
32
+
21
33
## 🌟 What is FCL?
22
34
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**.
24
36
25
37
### 🔑 Key Features:
26
38
- 🔌 **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
158
170
159
171
- See the [Flow App Quick Start](https://developers.flow.com/build/getting-started/fcl-quickstart).
160
172
- 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).
162
174
- Explore all of Flow [docs and tools](https://developers.flow.com).
163
175
164
176
## Development & Testing
@@ -222,7 +234,7 @@ The discovery feature can be used via API allowing you to customize your own UI
222
234
223
235
## 🛠 Want to Use the Flow SDK Directly?
224
236
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.
226
238
227
239
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.
228
240
@@ -231,3 +243,35 @@ FCL is built **on top of the Flow SDK**, making it easier to handle authenticati
231
243
- Notice a problem or want to request a feature? [Add an issue](https://github.com/onflow/fcl-js/issues).
232
244
- Join the Flow community on [Discord](https://discord.gg/flow) to keep up to date and to talk to the team.
233
245
- 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.
0 commit comments