Package Information
Available Nodes
Documentation generating…
Documentation
@n8n-dev/n8n-nodes-readme
Stop writing readme API integrations by hand.
Every time you connect n8n to readme, you waste hours mapping endpoints, defining parameters, and debugging schemas. You copy-paste from docs, fix edge cases, and pray nothing breaks.
What if connecting n8n to readme took 5 minutes, not half a day?
This node gives you 9+ resources out of the box: Projects, API Specification, Categories, Changelog, Custom Pages, and 4 more: with full CRUD operations, typed parameters, and zero manual configuration.
What You Get
- Zero boilerplate: Resources, operations, and fields are pre-configured and ready to use
- Full CRUD: Create, read, update, and delete support where the API allows it
- Typed parameters: No more guessing field types
- Built-in auth: API key authentication, ready to go
- Declarative: Native n8n performance, no custom execute() overhead
Install
npm install @n8n-dev/n8n-nodes-readme
Or in n8n:
- Settings → Community Nodes → Install
- Search:
@n8n-dev/n8n-nodes-readme - Click Install
Quick Start
- Install the node (above)
- Add credentials: readme API → paste your API key
- Drag the readme node into your workflow
- Pick a resource → pick an operation → done.
That's it. No configuration files. No code. It just works.
Resources
Projects (1 operations)
- Get metadata about the current project
API Specification (4 operations)
- Get API Specification
- Post Upload API Specification
- Delete API Specification
- Put Update API Specification
Categories (2 operations)
- Get category
- Get docs for category
Changelog (5 operations)
- Get changelogs
- Post Create changelog
- Delete changelog
- Get changelog
- Put Update changelog
Custom Pages (5 operations)
- Get custom pages
- Post Create custom page
- Delete custom page
- Get custom page
- Put Update custom page
Docs (5 operations)
- Post Create doc
- Post Search docs
- Delete doc
- Get doc
- Put Update doc
Errors (1 operations)
- Get errors
Version (5 operations)
- Get versions
- Post Create version
- Delete version
- Get version
- Put Update version
Why This Node?
Without this node:
- Hours of manual API integration
- Copy-pasting from readme docs
- Debugging auth, pagination, error handling
- Maintaining your own client code
With this node:
- Install → configure → use. 5 minutes.
- Auto-generated from the official readme OpenAPI spec
- Always up to date when the API changes
- Native n8n performance
Auto-Generated
This node was auto-generated from the official readme OpenAPI specification using
@n8n-dev/n8n-openapi-node-ultimate,
then validated against the live API so you get accurate types and real parameters, not guesswork.
When the readme API updates, this node updates too.
Support This Project
If this node saved you hours of work, consider supporting continued development, new APIs, better error handling, and faster updates.
License
MIT © kelvinzer0