Skip to content

Commit 7795d1f

Browse files
committed
Update README.md
1 parent 0b9d935 commit 7795d1f

1 file changed

Lines changed: 11 additions & 9 deletions

File tree

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
22

33
[Zenity](https://help.gnome.org/users/zenity/stable/) is a small program that allows
44
creating simple GTK+ dialogs from within command line scripts. This library provides
5-
an easy to use wrapper to spawn zenity processes to build graphical desktop applications
5+
an easy to use wrapper to spawn Zenity processes to build graphical desktop applications
66
with PHP.
77

88
Zenity already ships with Ubuntu-based distributions and does not require any installation
9-
there - so this library should work out of the box. Otherwise you may have to install
10-
zenity yourself.
9+
there - so this library should work out of the box. Otherwise you may have to [install
10+
Zenity](#install) yourself.
11+
12+
![https://help.gnome.org/users/zenity/stable/question.html](https://help.gnome.org/users/zenity/stable/figures/zenity-question-screenshot.png)
1113

1214
## Quickstart example
1315

@@ -36,7 +38,7 @@ Looking for more examples? Take a look at the [examples](examples) folder.
3638
### Launcher
3739

3840
As shown in the above example, a `Launcher` has to be instantiated once and
39-
is responsible for launching each zenity dialog. It manages running
41+
is responsible for launching each Zenity dialog. It manages running
4042
the underlying `zenity` process and reports back its state and user interaction.
4143

4244
It uses the [react/event-loop](https://github.com/reactphp/event-loop) component
@@ -61,7 +63,7 @@ $launcher->setBin('/some/other/path/zenity');
6163
#### waitFor()
6264

6365
The `waitFor($dialog)` method can be used to launch a given dialog and
64-
wait for the zenity process to return its result.
66+
wait for the Zenity process to return its result.
6567
This simple blocking API allows you to get started quickly without exposing
6668
all nifty async details - and lacking some of its advanced features:
6769

@@ -73,7 +75,7 @@ $result = $launcher->waitFor($dialog);
7375

7476
The `launch($dialog)` method can be used to asynchronously launch a given dialog
7577
and return a [Promise](https://github.com/reactphp/promise) that will be fulfilled
76-
when the zenity process returns.
78+
when the Zenity process returns.
7779
This async API enables you to launch multiple dialogs simultaneously while simultaneously
7880
doing more I/O work.
7981

@@ -84,7 +86,7 @@ $launcher->launch($dialog)->then(
8486
// text dialogs complete with their respective text
8587
},
8688
function ($reason) {
87-
// dialog was cancelled or their was an error launching the process
89+
// dialog was cancelled or there was an error launching the process
8890
}
8991
});
9092
```
@@ -93,7 +95,7 @@ $launcher->launch($dialog)->then(
9395

9496
The `launchZen($dialog)` method can be used to asynchronously launch a given dialog
9597
and return an instance of the `BaseZen` class.
96-
This instance exposes methods to control the zenity process while waiting for the results.
98+
This instance exposes methods to control the Zenity process while waiting for the results.
9799
Some dialog types also support modifying the information presented to the user.
98100

99101
```php
@@ -128,7 +130,7 @@ familar if you're already using it from within any other command line script.
128130

129131
#### AbstractDialog
130132

131-
Abstract base class for all zenity dialogs (see below for details on each concrete type).
133+
Abstract base class for all Zenity dialogs (see below for details on each concrete type).
132134

133135
#### CalendarDialog
134136

0 commit comments

Comments
 (0)