Skip to content

Commit 8ab822f

Browse files
committed
Add Readme file to the plugin
#6
1 parent 0546fb5 commit 8ab822f

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

src/README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
## Azure Blobs plugin for FlowSynx engine
2+
3+
The **Azure Blobs Plugin** is a pre-packaged, plug-and-play integration component for the FlowSynx engine. It enables secure and configurable access to Azure Blobs storage as part of FlowSynx no-code/low-code automation workflows.
4+
5+
This plugin can be installed automatically by the FlowSynx engine when selected within the platform. It is not intended for manual installation or developer use outside the FlowSynx environment.
6+
7+
---
8+
9+
## Purpose
10+
11+
This plugin allows FlowSynx users to interact with Azure Blobs for a variety of storage-related operations without writing code. Once installed, the plugin becomes available as a storage connector within the platform's workflow builder.
12+
13+
---
14+
15+
## Supported Operations
16+
17+
The plugin supports the following operations, which can be selected and configured within the FlowSynx UI:
18+
19+
| Operation| Description |
20+
|----------|-------------------------------------------|
21+
| `create` | Upload a new object to the blob container.|
22+
| `delete` | Remove an object from the container. |
23+
| `exist` | Check if an object exists. |
24+
| `list` | List all objects in the container. |
25+
| `purge` | Remove all contents in the container. |
26+
| `read` | Read and return the contents of an object.|
27+
| `write` | Overwrite or write new data to an object. |
28+
29+
---
30+
31+
## Notes
32+
33+
- This plugin is only supported on the FlowSynx platform.
34+
- It is installed automatically by the FlowSynx engine.
35+
- All operational logic is encapsulated and executed under FlowSynx control.
36+
- Credentials are configured through platform-managed settings.
37+
38+
---
39+
40+
## License
41+
42+
Copyright FlowSynx. All rights reserved.

0 commit comments

Comments
 (0)