From a7819fe2be0d87a4db0ac1bb3b14d28142b71f17 Mon Sep 17 00:00:00 2001
From: LynnL4 <lht856@foxmail.com>
Date: Tue, 10 Sep 2024 10:29:40 +0800
Subject: [PATCH] chore: release v0.0.1

---
 .gitignore   |  2 ++
 README       |  0
 README.md    | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 package.json | 21 +++++++++++++++++++--
 4 files changed, 69 insertions(+), 2 deletions(-)
 create mode 100644 .gitignore
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..15b2e16
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+.vscode
+*.tgz
diff --git a/README b/README
deleted file mode 100644
index e69de29..0000000
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f6480aa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+![Platform Node-RED](https://img.shields.io/badge/Platform-Node--RED-red.png)
+
+# node-red-contrib-sscma
+
+`node-red-contrib-sscma` is a Node-RED node component designed to facilitate the quick deployment of AI models through flow-based programming. This allows for seamless integration of AI model outputs with other devices, enabling smart automation and intelligent workflows.
+
+## Features
+
+- **AI Model Deployment**: Easily deploy AI models using Node-RED's flow-based programming interface, making it accessible for users with minimal coding experience.
+- **Device Integration**: Connect the outputs of AI models to a wide range of devices and services, allowing for real-time automation and decision-making.
+- **Flow-based Programming**: Leverage the visual programming paradigm of Node-RED to design and deploy complex AI workflows quickly and efficiently.
+- **Flexible Interconnection**: Utilize AI-driven data to communicate and control various devices in an IoT ecosystem.
+
+## Installation
+
+To install the package in Node-RED, run the following command:
+
+```bash
+npm install node-red-contrib-sscma
+```
+
+Or install directly through the Node-RED interface.
+
+## Getting Started
+
+1. Open Node-RED and navigate to the flow editor.
+2. Drag the `sscma` node into your workspace.
+3. Configure the node by selecting the AI model you wish to deploy.
+4. Connect the node to other nodes for input/output to interact with devices or services.
+5. Deploy the flow to start processing AI data.
+
+## Example
+
+Below is an example of how `node-red-contrib-sscma` can be used in a flow to connect an AI model’s output to a device:
+
+```
+[ Camera Node ] → [ Model Node ] → [ Output Device Node ]
+```
+
+This flow processes data using an AI model and sends the results to a connected device for further action.
+
+## License
+
+This project is licensed under the Apache License 2.0. You may obtain a copy of the License at:
+
+---
+
+Let me know if you need any other modifications!
\ No newline at end of file
diff --git a/package.json b/package.json
index 1cda37f..2875c41 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,13 @@
 {
-    "name": "node-red-sscma",
+    "name": "node-red-contrib-sscma",
+    "version": "0.0.1",
+    "description": "Node-RED nodes for SSCMA",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/seeed-studio/node-red-contrib-sscma.git"
+    },
     "node-red": {
+        "version": ">=3.0.0",
         "nodes": {
             "camera": "camera.js",
             "model": "model.js",
@@ -10,5 +17,15 @@
             "sscma": "sscma.js"
         }
     },
-    "version": "0.0.2"
+    "license": "Apache-2.0",
+    "keywords": [
+        "node-red",
+        "sscma",
+        "vision ai"
+    ],
+    "dependencies":{
+        "node-red": ">=3.0.0",
+        "mqtt": ">=4.3.7"
+    }
+
 }
\ No newline at end of file