Skip to content

Commit

Permalink
Adding GitHub importer to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
raguay committed Aug 18, 2022
1 parent d8f60bd commit c5d8af2
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 4 deletions.
41 changes: 38 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -446,6 +446,38 @@ on this base. These endpoints only allow access from requests on the same machin

All the endpoints are used to make the plugins for Alfred, Keyboard Maestro, Dropzone, PopClip, and Launchpad. Also, the ScriptBar program uses these endpoints as well. I'm planning to add serving pages on the user's computer and other functionality as well. I have lots of ideas.

### GitHub

![GitHub Importer Screen](/images/github.png)

The GitHub importing screen allows you go import external scripts and themes that are stored on GitHub. To install the script or theme, click the `install` button. Themes then have an extra button to `load` the theme downloaded.

In order for this importer to find the script and themes, your script or theme has to have the `emailit` topic. A script will need the `script` topic as well, while a theme will need the `theme` topic included.

When a script or theme is downloaded, a `delete` button will be shown. You can remove the script or theme by pressing the `delete` button.

In order to load the script properly, the `package.json` file in the script's repository has to have these added fields:

```json
"script": {
"name": <name of the script>,
"description": <a short description of what the script does>,
"help": <help text for the script>,
"termscript": <boolean flag for a Script Terminal script (true if it is a script terminal script. Otherwise, false.)>,
"script": <the scripts full name in the repository including extension>,
}
```

In order to load the theme properly, the `package.json` file for the theme's repository has to have these added fields:

```json
"theme": {
"name": <name of the theme>,
"description": <description of the theme>,
"main": <the json file for the theme>,
}
```

## Change Log

### Features to add/fix - not in order
Expand All @@ -459,18 +491,21 @@ All the endpoints are used to make the plugins for Alfred, Keyboard Maestro, Dro
- Get it working on Linux and Windows.
- BullitenBoard: A program to display messages and dialogs to the user. Currently a NW.js program. Move it to Wails.
- Add in the regular expressions editor and runner.
- Make the automatic launching of ScriptBar programmable/optional.
- Get ScriptBar able to use xBar scripts.
- Launching the adding of different workflows/extensions to other programs (Alfred, LaunchBar, Keyboard Maestro, etc.)
- Test running on a new system.
- ScriptBar: Have a message to add items when there isn't a configuration.
- User created handlebar helpers and macros.
- Undo history working.
- Allow the EmailIt server to send web pages on the users system.


### Change Log:

#### August 18, 2022

- Removed auto launch of ScriptBar. Latest update to macOS will not allow me to without code signing.
- Moved documentation of ScriptBar to the ScriptBar repository.
- Added GitHub importing of External Scripts and Themes.

#### August 10, 2022

- EmailIt is a full Wails application that has the EmailIt server and ScriptBar embedded and launched from the program.
Expand Down
2 changes: 1 addition & 1 deletion frontend/src/components/GitHub.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@
name: cfg.script.name,
script: cfg.script.script,
path: extDir,
env: cfg.script.env,
env: "Default",
termscript: cfg.script.termscript,
description: cfg.script.description,
help: cfg.script.help,
Expand Down
Binary file added images/github.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions maskfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
wails build --platform "darwin/universal"
cp ../EmailItServer/EmailItServer build/bin/EmailIt.app/Contents/MacOS/
```

0 comments on commit c5d8af2

Please sign in to comment.