diff --git a/README.md b/README.md index 3401c3726..6516f8466 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,30 @@ # Node-RED -https://nodered.org +

+
+ License: Apache 2.0 + + Build Status + + + Node-RED Forum on Discourse + + + Slack + +
+
+

-[![Build Status](https://github.com/node-red/node-red/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/node-red/node-red/actions?query=branch%3Amaster) - -Low-code programming for event-driven applications. - -![Node-RED: Low-code programming for event-driven applications](https://nodered.org/images/node-red-screenshot.png) +

+ +

+

Low-code programming for event-driven applications

+
+ + + +
## Quick Start @@ -17,13 +35,30 @@ started. 2. `node-red` 3. Open -## Getting Help +> [!NOTE] +> More documentation can be found [here](https://nodered.org/docs). For further help, or general discussion, please join the [Node-RED Forum](https://discourse.nodered.org) or [Node-RED Slack](https://nodered.org/slack). -More documentation can be found [here](https://nodered.org/docs). +## Links -For further help, or general discussion, please use the [Node-RED Forum](https://discourse.nodered.org) or [slack team](https://nodered.org/slack). +- [Documentation ↗](https://nodered.org/docs/) +- [About ↗](https://nodered.org/about/) +- [Installation ↗](https://nodered.org/#get-started) +- Roadmap (Coming soon) +- Experiments (Coming soon) +- Demo (Coming soon) +- Usecases (Coming soon) +- Features (Coming soon) +- [Node-RED Library ↗](https://flows.nodered.org/) + - [Custom Nodes & Integrations ↗](https://flows.nodered.org/search?type=node) + - [Shared Flows ↗](https://flows.nodered.org/search?type=flow) + - [Node Collections ↗](https://flows.nodered.org/search?type=collection) +- Accessibility (Coming soon) +- Translations (Coming soon) +- [Development](#development) +- [Contributing](#contributing) +- [Copyright and license](#copyright-and-license) -## Developers +## Development If you want to run the latest code from git, here's how to get started: @@ -46,24 +81,36 @@ If you want to run the latest code from git, here's how to get started: ## Contributing -Before raising a pull-request, please read our -[contributing guide](https://github.com/node-red/node-red/blob/master/CONTRIBUTING.md). +Before raising a pull-request, please read our [contributing guide](https://github.com/node-red/node-red/blob/master/CONTRIBUTING.md). -This project adheres to the [Contributor Covenant 1.4](http://contributor-covenant.org/version/1/4/). - By participating, you are expected to uphold this code. Please report unacceptable - behavior to any of the project's core team at team@nodered.org. +This project adheres to the [Contributor Covenant 1.4](http://contributor-covenant.org/version/1/4/). By participating, you are expected to uphold this code. Please report unacceptable behavior to any of the project's core team at team@nodered.org. -## Authors +### Star history -Node-RED is a project of the [OpenJS Foundation](http://openjsf.org). + + + + + Star History Chart + + + +### Contributors It is maintained by: * Nick O'Leary [@knolleary](http://twitter.com/knolleary) * Dave Conway-Jones [@ceejay](http://twitter.com/ceejay) - * And many others... + * And many others: + + + ## Copyright and license +Node-RED is a project of the [OpenJS Foundation](http://openjsf.org). + +![OpenJS Foundation](https://nodered.org/images/openjs_foundation-logo.svg) + Copyright OpenJS Foundation and other contributors, https://openjsf.org under [the Apache 2.0 license](LICENSE).