From 33efa0e7d76ab59a2a1b8c0aae82e719c0af154e Mon Sep 17 00:00:00 2001 From: Sander Date: Sun, 11 Aug 2024 00:15:57 +0200 Subject: [PATCH] init README --- README.md | 22 +++++++++++++++++++++- apps/electron-app/package.json | 2 +- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6dd828d..961356c 100644 --- a/README.md +++ b/README.md @@ -1 +1,21 @@ -https://github.com/joezappie/yarn-electron-workspaces +# Microflow + +A set of tools to make it easier to start prototyping for interactivity. + +Microflow consists of 2 applications so far: + +1. Microflow studio +2. Microflow hardware bridge (Figma plugin) + +## Microflow studio + +Microflow studio is a desktop application that allows you to create interactive prototypes using a visual, flow-based, interface. + +Download the latest release from the [releases page](https://github.com/xiduzo/microflow/releases) and get started. + + +## Microflow hardware bridge + +Microflow hardware bridge is a Figma plugin that allows you to connect your Figma designs to the Microflow studio application. + +Microflow hardware bridge also allows you to connect to your MQTT broker of choice and does not require the Microflow studio application to get started. diff --git a/apps/electron-app/package.json b/apps/electron-app/package.json index 66b9354..79c8994 100644 --- a/apps/electron-app/package.json +++ b/apps/electron-app/package.json @@ -7,7 +7,7 @@ "url": "https://github.com/xiduzo/microflow-studio" }, "version": "0.1.1", - "description": "An application which allows you to create flow-based logic for microcontrollers", + "description": "An application which allows you to create flow-based logic for micro-controllers", "author": { "name": "Sander Boer", "email": "mail@sanderboer.nl",