mirror of
https://github.com/node-red/node-red.git
synced 2023-10-10 13:36:53 +02:00
Add README files to each package
This commit is contained in:
parent
36dc1d2f97
commit
0ddb4c625d
@ -44,9 +44,6 @@ If you want to run the latest code from git, here's how to get started:
|
|||||||
4. Run
|
4. Run
|
||||||
|
|
||||||
npm start
|
npm start
|
||||||
or
|
|
||||||
|
|
||||||
node red.js
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
@ -16,8 +16,12 @@
|
|||||||
"docs": "grunt docs"
|
"docs": "grunt docs"
|
||||||
},
|
},
|
||||||
"contributors": [
|
"contributors": [
|
||||||
{ "name": "Nick O'Leary" },
|
{
|
||||||
{ "name": "Dave Conway-Jones"}
|
"name": "Nick O'Leary"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Dave Conway-Jones"
|
||||||
|
}
|
||||||
],
|
],
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"ajv": "6.5.2",
|
"ajv": "6.5.2",
|
||||||
|
12
packages/node_modules/@node-red/editor-api/README.md
generated
vendored
Normal file
12
packages/node_modules/@node-red/editor-api/README.md
generated
vendored
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
@node-red/editor-api
|
||||||
|
====================
|
||||||
|
|
||||||
|
Node-RED editor api module.
|
||||||
|
|
||||||
|
This provides an Express application that can be used to serve the Node-RED
|
||||||
|
editor.
|
||||||
|
|
||||||
|
|
||||||
|
### Source
|
||||||
|
|
||||||
|
The main Node-RED modules are maintained as a monorepo on [GitHub](https://github.com/node-red/node-red).
|
10
packages/node_modules/@node-red/editor-client/README.md
generated
vendored
Normal file
10
packages/node_modules/@node-red/editor-client/README.md
generated
vendored
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
@node-red/editor-client
|
||||||
|
====================
|
||||||
|
|
||||||
|
Node-RED editor resources module.
|
||||||
|
|
||||||
|
This provides all of the client-side resources of the Node-RED editor application.
|
||||||
|
|
||||||
|
### Source
|
||||||
|
|
||||||
|
The main Node-RED modules are maintained as a monorepo on [GitHub](https://github.com/node-red/node-red).
|
10
packages/node_modules/@node-red/nodes/README.md
generated
vendored
Normal file
10
packages/node_modules/@node-red/nodes/README.md
generated
vendored
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
@node-red/nodes
|
||||||
|
====================
|
||||||
|
|
||||||
|
Node-RED core nodes module.
|
||||||
|
|
||||||
|
This provides all of the core Node-RED nodes.
|
||||||
|
|
||||||
|
### Source
|
||||||
|
|
||||||
|
The main Node-RED modules are maintained as a monorepo on [GitHub](https://github.com/node-red/node-red).
|
11
packages/node_modules/@node-red/registry/README.md
generated
vendored
Normal file
11
packages/node_modules/@node-red/registry/README.md
generated
vendored
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
@node-red/registry
|
||||||
|
====================
|
||||||
|
|
||||||
|
Node-RED node registry module.
|
||||||
|
|
||||||
|
This provides the node registry, responsible for discovering and managing the node
|
||||||
|
modules available to the Node-RED runtime.
|
||||||
|
|
||||||
|
### Source
|
||||||
|
|
||||||
|
The main Node-RED modules are maintained as a monorepo on [GitHub](https://github.com/node-red/node-red).
|
11
packages/node_modules/@node-red/runtime/README.md
generated
vendored
Normal file
11
packages/node_modules/@node-red/runtime/README.md
generated
vendored
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
@node-red/runtime
|
||||||
|
====================
|
||||||
|
|
||||||
|
Node-RED runtime module.
|
||||||
|
|
||||||
|
This provides the core flow engine of Node-RED. It is the main entry point for
|
||||||
|
the runtime.
|
||||||
|
|
||||||
|
### Source
|
||||||
|
|
||||||
|
The main Node-RED modules are maintained as a monorepo on [GitHub](https://github.com/node-red/node-red).
|
10
packages/node_modules/@node-red/util/README.md
generated
vendored
Normal file
10
packages/node_modules/@node-red/util/README.md
generated
vendored
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
@node-red/util
|
||||||
|
====================
|
||||||
|
|
||||||
|
Node-RED utilities module.
|
||||||
|
|
||||||
|
This provides common utilities shared by the Node-RED components.
|
||||||
|
|
||||||
|
### Source
|
||||||
|
|
||||||
|
The main Node-RED modules are maintained as a monorepo on [GitHub](https://github.com/node-red/node-red).
|
75
packages/node_modules/node-red/README.md
generated
vendored
Normal file
75
packages/node_modules/node-red/README.md
generated
vendored
Normal file
@ -0,0 +1,75 @@
|
|||||||
|
# Node-RED
|
||||||
|
|
||||||
|
http://nodered.org
|
||||||
|
|
||||||
|
[![Build Status](https://travis-ci.org/node-red/node-red.svg)](https://travis-ci.org/node-red/node-red)
|
||||||
|
[![Coverage Status](https://coveralls.io/repos/node-red/node-red/badge.svg?branch=master)](https://coveralls.io/r/node-red/node-red?branch=master)
|
||||||
|
|
||||||
|
A visual tool for wiring the Internet of Things.
|
||||||
|
|
||||||
|
![Node-RED: A visual tool for wiring the Internet of Things](http://nodered.org/images/node-red-screenshot.png)
|
||||||
|
|
||||||
|
### Repository Structure
|
||||||
|
|
||||||
|
This is a [monorepo](https://en.wikipedia.org/wiki/Monorepo) containing the source
|
||||||
|
code for all of the Node-RED component modules.
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
Check out http://nodered.org/docs/getting-started/ for full instructions on getting
|
||||||
|
started.
|
||||||
|
|
||||||
|
1. `sudo npm install -g --unsafe-perm node-red`
|
||||||
|
2. `node-red`
|
||||||
|
3. Open <http://localhost:1880>
|
||||||
|
|
||||||
|
## Getting Help
|
||||||
|
|
||||||
|
More documentation can be found [here](http://nodered.org/docs).
|
||||||
|
|
||||||
|
For further help, or general discussion, please use the [Node-RED Forum](https://discourse.nodered.org) or [slack team](https://nodered.org/slack).
|
||||||
|
|
||||||
|
## Developers
|
||||||
|
|
||||||
|
If you want to run the latest code from git, here's how to get started:
|
||||||
|
|
||||||
|
1. Clone the code:
|
||||||
|
|
||||||
|
git clone https://github.com/node-red/node-red.git
|
||||||
|
cd node-red
|
||||||
|
|
||||||
|
2. Install the node-red dependencies
|
||||||
|
|
||||||
|
npm install
|
||||||
|
|
||||||
|
3. Build the code
|
||||||
|
|
||||||
|
npm run build
|
||||||
|
|
||||||
|
4. Run
|
||||||
|
|
||||||
|
npm start
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
## Authors
|
||||||
|
|
||||||
|
Node-RED is a project of the [JS Foundation](http://js.foundation).
|
||||||
|
|
||||||
|
It was created by [IBM Emerging Technology](https://www.ibm.com/blogs/emerging-technology/).
|
||||||
|
|
||||||
|
* Nick O'Leary [@knolleary](http://twitter.com/knolleary)
|
||||||
|
* Dave Conway-Jones [@ceejay](http://twitter.com/ceejay)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Copyright and license
|
||||||
|
|
||||||
|
Copyright JS Foundation and other contributors, http://js.foundation under [the Apache 2.0 license](LICENSE).
|
Loading…
Reference in New Issue
Block a user