\r\n \r\n\r\n\r\n\r\n\r\n## About The Project\r\n\r\nThis project extends the basic node-red node types with new nodes that encapsulate Butter Robotics operations and api calls.\r\nThis can prove very useful when building IoT flows and orchestration using Node-Red, and needing to use Butter as well.\r\n\r\n\r\n### Built With\r\n\r\n* [Butter Javascript API](https://github.com/butter-robotics/Butter.MAS.JavascriptAPI)\r\n* [Node-Red](https://nodered.org/)\r\n\r\n\r\n\r\n## Getting Started\r\n\r\nTo get a local copy up and running follow these simple steps.\r\n\r\n\r\n### Prerequisites\r\n\r\n* Node-Red\r\n (Please refer to this [documentation](https://nodered.org/docs/getting-started/windows) for easy installation on Windows).\r\n\r\n\r\n### Installation\r\n\r\n* Install the package.\r\n ```sh\r\n npm install @butter-robotics/mas-node-red-api@latest -g\r\n ```\r\n* Restart Node-Red and validate that the new nodes exist in your node pallette.\r\n\r\n\r\n\r\n## Usage\r\n\r\nOnce you have completed the prerequisites, the new nodes should appear in all their glory in the node pallette:\r\n\r\n\r\n\r\nYou can drag the butter nodes to use in your flows:\r\n\r\n\r\n\r\nFor further explanation, please refer to the documentation given inside the node-red GUI.\r\n\r\n\r\n_To learn more about Node-Red, please refer to their [Documentation](https://nodered.org/docs/)_\\\r\n_To understand more about Butter Robotics Javascript API, please refer to this [Documentation](https://github.com/butter-robotics/Butter.MAS.JavascriptAPI)_\r\n\r\n\r\n## Contributing\r\n\r\nWe always have space for improvements, here is how to help:\r\n\r\n1) Fork the repo.\r\n2) Submit a PR.\r\n3) Bump the version in package.json.\r\n4) Write a concise summary of your change in the RELEASE-NOTES.md file. \r\n\r\n\r\n## License\r\n\r\nDistributed under the Apache 2.0 License. See `LICENSE` for more information.\r\n\r\n## Authors\r\n\r\n* [Ron Gissin](https://github.com/RonGissin)\r\n* [Benny Megidish](https://github.com/bennymeg)\r\n\r\n\r\n\r\n","readmeFilename":"README.md"}
![\"Logo\"](\"src/nodes/icons/butter-node-red-logo.png\"){kind=icon}
\r\n \r\n\r\n