Skip to content

Improved readme#5340

Merged
knolleary merged 20 commits intonode-red:masterfrom
dimitrieh:improved-readme
Nov 5, 2025
Merged

Improved readme#5340
knolleary merged 20 commits intonode-red:masterfrom
dimitrieh:improved-readme

Conversation

@dimitrieh
Copy link
Copy Markdown
Contributor

@dimitrieh dimitrieh commented Oct 30, 2025

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Update readme

Proposed changes

Update the Node-RED repository readme to be more up to date/modern and inform better about contributers and contributions ahead of Node-RED con.

See the readme rendered here: https://github.com/dimitrieh/node-red/tree/improved-readme

Checklist

  • I have read the contribution guidelines
  • [-] For non-bugfix PRs, I have discussed this change on the forum/slack team.
  • [-] I have run npm run test to verify the unit tests pass
  • [-] I have added suitable unit tests to cover the new/changed functionality

@dimitrieh
Copy link
Copy Markdown
Contributor Author

@knolleary let me know what you think here. Inspired by the readme of https://github.com/immich-app/immich/

@dimitrieh
Copy link
Copy Markdown
Contributor Author

We can additionally consider displaying something like this graph they display on their readme:

Activities

It uses https://repobeats.axiom.co/ but requires certain permissions it seems.

Updated the Forum badge color from Node-RED red (#8f0000) to Discourse's official blue (#17B4E6) for better brand recognition.
- Removed Node-RED logo from library badges
- Removed redundant suffix words (nodes/flows/collections)
- Added descriptive labels (Nodes/Flows/Collections) instead
- Badges now show cleaner format: "Nodes: 5656" instead of logo + "5656 nodes"
@dimitrieh
Copy link
Copy Markdown
Contributor Author

ready for review

Copy link
Copy Markdown
Member

@knolleary knolleary left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Couple comments to consider.

dimitrieh and others added 2 commits November 4, 2025 11:15
Co-authored-by: Nick O'Leary <nick.oleary@gmail.com>
@dimitrieh dimitrieh requested a review from knolleary November 4, 2025 10:18
@dimitrieh
Copy link
Copy Markdown
Contributor Author

@knolleary ready for review again :).

Also mentioned in https://flowforgeworkspace.slack.com/archives/C021LKE5EAY/p1762253601026259

@knolleary knolleary merged commit 7700aa9 into node-red:master Nov 5, 2025
5 checks passed
@dimitrieh
Copy link
Copy Markdown
Contributor Author

@knolleary great this got merged 💪. Do you want to highlight this on "lowest threshold" socials? Thinking slack, discord, bsky etc? Maybe mentioning it inside of the existing forum post of the Node-RED con? Thinking here is: celebrating small wins instead of only voicing big wins. This will set us up slowly for more continued engagement.

Side thought: Pondering how we could visualise the latest 1-3 topics from the forum and/or latest blogpost in the readme 🤔

@dimitrieh
Copy link
Copy Markdown
Contributor Author

Also curious towards your thoughts on #5340 (comment)

@knolleary
Copy link
Copy Markdown
Member

I don't think we need to promote the fact we've updated the readme in light of all the other things we want to share in the coming days. If every time I commit something I need to post to multiple channels about the fact, I won't get anything done.

@knolleary
Copy link
Copy Markdown
Member

To clarify, when I post about the roadmap plans, I can certainly point back to this as an example of incremental improvement.

@dceejay
Copy link
Copy Markdown
Member

dceejay commented Nov 5, 2025

Doh - should have said earlier - I rarely use twitter so no point linking to me there :-)

@Semmu
Copy link
Copy Markdown

Semmu commented Dec 25, 2025

Sorry for sharing my opinion without being asked for, but this PR feels really weird. The README file's extension is .md/markdown, which is supposed to be an easily readable format as plaintext AND as HTML rendered, but now it's basically full of HTML markup, which completely defeats the purpose of this format. It is now really hard to read and work with in a simple text editor.

@dimitrieh
Copy link
Copy Markdown
Contributor Author

@Semmu I agree there was an optimisation here for the rendered markdown view on GitHub rather than when reading this readme with an IDE. As a proposal, what if we minified the html, especially at the top, to all be on one line? Let me know your thoughts

@dceejay
Copy link
Copy Markdown
Member

dceejay commented Jan 6, 2026

Most of it looks like images and links which can be written in markdown. so why not use real markdown for most of it ?

@dimitrieh
Copy link
Copy Markdown
Contributor Author

Created #5423 to resolve this problem

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants