Skip to content

Commit ec679c9

Browse files
rodrigosnaderclaudemendonkogabrielluiz
authored
docs: Improve README Quickstart section and add dark mode logo (#10358)
* Improve README Quickstart section and reorganize installation options - Add prominent Desktop download section before Quickstart - Remove $ symbols from shell commands to fix copy button functionality - Add clear 'Run from source' option with make run_cli for developers - Improve Docker installation instructions with usage details - Move security warnings to after installation options for better flow - Remove redundant star/issues badges These changes address common user confusion when trying to run Langflow, especially for developers who clone the repo first and then struggle with the package installation instructions. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Add dark mode logo support - Added picture element for automatic dark/light mode logo switching - Dark mode shows blue background logo, light mode shows black logo 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Final README improvements - Made 'Other install options' a proper section with emoji - Updated deployment section with rocket emoji - Fixed single-line formatting for subsections - Added new star animation gif - Changed 'tool' to 'platform' in description * Improve Desktop download section messaging - Made text more concise and action-oriented - Changed download emoji from arrow to inbox - Removed redundant 'built-in' and bold formatting - Cleaner parenthetical for OS availability * Revise README for Langflow Desktop and deployment info Updated sections for clarity and added details about Langflow Desktop and deployment options. * Revert star gif to GitHub attachment URL Testing if local file path issue or markdown previewer issue * Apply suggestion from @mendonk * Apply suggestion from @mendonk * Apply suggestion from @mendonk * Apply suggestion from @mendonk * readme-changes * Apply suggestion from @mendonk --------- Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Co-authored-by: Gabriel Luiz Freitas Almeida <gabriel@langflow.org>
1 parent 46ba809 commit ec679c9

3 files changed

Lines changed: 62 additions & 22 deletions

File tree

README.md

Lines changed: 41 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,19 @@
11
<!-- markdownlint-disable MD030 -->
22

3-
![Langflow logo](./docs/static/img/langflow-logo-color-black-solid.svg)
3+
<picture>
4+
<source media="(prefers-color-scheme: dark)" srcset="./docs/static/img/langflow-logo-color-blue-bg.svg">
5+
<img src="./docs/static/img/langflow-logo-color-black-solid.svg" alt="Langflow logo">
6+
</picture>
47

58
[![Release Notes](https://img.shields.io/github/release/langflow-ai/langflow?style=flat-square)](https://github.com/langflow-ai/langflow/releases)
69
[![PyPI - License](https://img.shields.io/badge/license-MIT-orange)](https://opensource.org/licenses/MIT)
710
[![PyPI - Downloads](https://img.shields.io/pypi/dm/langflow?style=flat-square)](https://pypistats.org/packages/langflow)
8-
[![GitHub star chart](https://img.shields.io/github/stars/langflow-ai/langflow?style=flat-square)](https://star-history.com/#langflow-ai/langflow)
9-
[![Open Issues](https://img.shields.io/github/issues-raw/langflow-ai/langflow?style=flat-square)](https://github.com/langflow-ai/langflow/issues)
1011
[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/langflow-ai.svg?style=social&label=Follow%20%40Langflow)](https://twitter.com/langflow_ai)
1112
[![YouTube Channel](https://img.shields.io/youtube/channel/subscribers/UCn2bInQrjdDYKEEmbpwblLQ?label=Subscribe)](https://www.youtube.com/@Langflow)
1213
[![Discord Server](https://img.shields.io/discord/1116803230643527710?logo=discord&style=social&label=Join)](https://discord.gg/EqksyE2EX9)
1314
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/langflow-ai/langflow)
1415

15-
> [!CAUTION]
16-
> - Langflow versions 1.6.0 through 1.6.3 have a critical bug where `.env` files are not read, potentially causing security vulnerabilities. **DO NOT** upgrade to these versions if you use `.env` files for configuration. Instead, upgrade to 1.6.4, which includes a fix for this bug.
17-
> - Windows users of Langflow Desktop should **not** use the in-app update feature to upgrade to Langflow version 1.6.0. For upgrade instructions, see [Windows Desktop update issue](https://docs.langflow.org/release-notes#windows-desktop-update-issue).
18-
> - Users must update to Langflow >= 1.3 to protect against [CVE-2025-3248](https://nvd.nist.gov/vuln/detail/CVE-2025-3248)
19-
> - Users must update to Langflow >= 1.5.1 to protect against [CVE-2025-57760](https://github.com/langflow-ai/langflow/security/advisories/GHSA-4gv9-mp8m-592r)
20-
>
21-
> For security information, see our [Security Policy](./SECURITY.md) and [Security Advisories](https://github.com/langflow-ai/langflow/security/advisories).
22-
23-
[Langflow](https://langflow.org) is a powerful tool for building and deploying AI-powered agents and workflows. It provides developers with both a visual authoring experience and built-in API and MCP servers that turn every workflow into a tool that can be integrated into applications built on any framework or stack. Langflow comes with batteries included and supports all major LLMs, vector databases and a growing library of AI tools.
16+
[Langflow](https://langflow.org) is a powerful platform for building and deploying AI-powered agents and workflows. It provides developers with both a visual authoring experience and built-in API and MCP servers that turn every workflow into a tool that can be integrated into applications built on any framework or stack. Langflow comes with batteries included and supports all major LLMs, vector databases and a growing library of AI tools.
2417

2518
## ✨ Highlight features
2619

@@ -33,6 +26,13 @@
3326
- **Observability** with LangSmith, LangFuse and other integrations.
3427
- **Enterprise-ready** security and scalability.
3528

29+
## 🖥️ Langflow Desktop
30+
31+
Langflow Desktop is the easiest way to get started. It includes dependency management and automatic updates.
32+
Available for Windows and macOS.
33+
34+
[📥 Download Langflow Desktop](https://www.langflow.org/desktop)
35+
3636
## ⚡️ Quickstart
3737

3838
### Install locally (recommended)
@@ -41,34 +41,53 @@ Requires Python 3.10–3.13 and [uv](https://docs.astral.sh/uv/getting-started/i
4141

4242
#### Install
4343

44+
From a fresh directory, run:
4445
```shell
4546
uv pip install langflow -U
4647
```
4748

48-
Installs the latest Langflow package.
49+
The latest Langflow package is installed.
50+
For more information, see [Install and run the Langflow OSS Python package](https://docs.langflow.org/get-started-installation#install-and-run-the-langflow-oss-python-package).
4951

5052
#### Run
5153

54+
To start Langflow, run:
5255
```shell
5356
uv run langflow run
5457
```
5558

56-
Starts the Langflow server at http://127.0.0.1:7860.
59+
Langflow starts at http://127.0.0.1:7860.
5760

58-
That's it! You're ready to build with Langflow 🎉
61+
That's it! You're ready to build with Langflow! 🎉
5962

60-
### Other install options
63+
## 📦 Other install options
6164

62-
- [Docker](https://docs.langflow.org/deployment-docker)
63-
- [Desktop app](https://docs.langflow.org/get-started-installation#install-and-run-langflow-desktop)
65+
### Run from source
66+
If you've cloned this repository and want to contribute, run this command from the repository root:
67+
```shell
68+
make run_cli
69+
```
70+
For more information, see [DEVELOPMENT.md](./DEVELOPMENT.md).
6471

65-
### Install from repo
72+
### Docker
73+
Start a Langflow container with default settings:
74+
```shell
75+
docker run -p 7860:7860 langflowai/langflow:latest
76+
```
77+
Langflow is available at http://localhost:7860/.
78+
For configuration options, see the [Docker deployment guide](https://docs.langflow.org/deployment-docker).
6679

67-
If you're contributing or running from source, see [DEVELOPMENT.md](./DEVELOPMENT.md) for setup instructions.
80+
> [!CAUTION]
81+
> - Langflow versions 1.6.0 through 1.6.3 have a critical bug where `.env` files are not read, potentially causing security vulnerabilities. **DO NOT** upgrade to these versions if you use `.env` files for configuration. Instead, upgrade to 1.6.4, which includes a fix for this bug.
82+
> - Windows users of Langflow Desktop should **not** use the in-app update feature to upgrade to Langflow version 1.6.0. For upgrade instructions, see [Windows Desktop update issue](https://docs.langflow.org/release-notes#windows-desktop-update-issue).
83+
> - Users must update to Langflow >= 1.3 to protect against [CVE-2025-3248](https://nvd.nist.gov/vuln/detail/CVE-2025-3248)
84+
> - Users must update to Langflow >= 1.5.1 to protect against [CVE-2025-57760](https://github.com/langflow-ai/langflow/security/advisories/GHSA-4gv9-mp8m-592r)
85+
>
86+
> For security information, see our [Security Policy](./SECURITY.md) and [Security Advisories](https://github.com/langflow-ai/langflow/security/advisories).
6887
69-
## 📦 Deployment
88+
## 🚀 Deployment
7089

71-
Langflow is completely open source, and you can deploy it to all major clouds. To learn how to use Docker to deploy Langflow, see the [Docker deployment guide](https://docs.langflow.org/deployment-docker).
90+
Langflow is completely open source and you can deploy it to all major deployment clouds. To learn how to deploy Langflow, see our [Langflow deployment guides](https://docs.langflow.org/deployment-overview).
7291

7392
## ⭐ Stay up-to-date
7493

Lines changed: 21 additions & 0 deletions
Loading

docs/static/img/star-langflow.gif

28.7 MB
Loading

0 commit comments

Comments
 (0)