From 1495375b3355278b79e332e87027e3f2055c4653 Mon Sep 17 00:00:00 2001 From: Jamie Mason Date: Thu, 14 Feb 2019 16:05:03 +0000 Subject: [PATCH] docs(readme): update usage info --- README.md | 29 ++++++++++++++++++++++------- 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 51da7b8..ffdfd46 100644 --- a/README.md +++ b/README.md @@ -12,18 +12,15 @@ ## 🗒 Overview -Everything you love about https://astexplorer.net plus: - -✅ Hot Reloading.
-✅ Support for ES Modules in your Transforms.
-✅ Edit Transforms in your IDE.
-✅ Work Offline. +Everything you love about https://astexplorer.net plus:

✅ Support for ES +Modules in your Transforms.
✅ Edit Transforms in your IDE.
✅ Hot +Reloading.
✅ Work Offline. ## 📸 Screenshot
-## 🧐 Status +## 🙋🏽 Status New Project, there will likely be a few kinks to iron out. @@ -67,3 +64,21 @@ When the App is started: 1. `/src/inject.js` listens for messages frpm `/src/index.js` using [`ipcRenderer`](https://electronjs.org/docs/api/ipc-renderer) then forwards the changes to AST Explorer's Redux Store. + +### Development Scripts + +#### `yarn start` + +Create and run the App quickly for Development purposes +[[more info](https://github.com/electron-userland/electron-forge/tree/5.x#launching-your-project)]. + +#### `yarn run electron:package` + +Create the Application on disk. +[[more info](https://github.com/electron-userland/electron-forge/tree/5.x#packaging-your-project)] + +#### `yarn run electron:make` + +Create the Application for various Platforms, plus installers, distribution +packages, etc. +[[more info](https://github.com/electron-userland/electron-forge/tree/5.x#generating-a-distributable-for-your-project)].