Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typographical Fix #46

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Typographical Fix #46

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b38cc0
Typographical Fix
juliojimenez Jul 27, 2019
20d962e
Merge branch 'master' into readme
juliojimenez Dec 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ When everything worked you should see this


### Use Your Own WebUI
gotron expects a folder containing your HTML/JS/CSS code and passes it to electronJS. make sure it contains at least a index.html as entrypoint.
gotron expects a folder containing your HTML/JS/CSS code and passes it to electronJS. Make sure it contains at least an index.html as an entrypoint.

Pass a path to your webUI on gotrons `New(uiFolder ...string)` function.
Pass a path to your webUI on gotron's `New(uiFolder ...string)` function.
```go
window, err := gotron.New("path/to/your/webui")
if err != nil {
Expand All @@ -67,7 +67,7 @@ if err != nil {

### Communicate between backend and frontend

Frontend to backend communication is realized through javascript like event driven apporach.
Frontend to backend communication is realized through javascript like event driven approach.

#### Backend

Expand All @@ -94,7 +94,7 @@ window.Send(&CustomEvent{

#### Frontend

In frontend a websocket needs to be created. Adress is always localhost and port can be taken from global variable `global.backendPort`
In frontend a websocket needs to be created. Address is always localhost and port can be taken from global variable `global.backendPort`
```javascript
let ws = new WebSocket("ws://localhost:" + global.backendPort + "/web/app/events");
```
Expand Down Expand Up @@ -126,13 +126,13 @@ ws.send(JSON.stringify({
To package a go application together with electornjs use `gotron-builder`.

#### Install gotron-builder
We provide executables for Linux, MacOS and Windows.
We provide executables for Linux, MacOS, and Windows.
Download the newest release from [https://github.com/Equanox/gotron/releases](https://github.com/Equanox/gotron/releases) and add it to your $PATH.

#### Using gotron-builder
It expects...
* a directory containing a golang main package
* and a directory with a webUI containing at least a index.html
* and a directory with a webUI containing at least an index.html

By default it will implicitly use...
* golang main package from the current directory
Expand Down