Skip to content

Commit 21dd7a6

Browse files
committed
Improve documentation
1 parent 23326fa commit 21dd7a6

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ It offers a common SQL interface to process queries to work with its relational
1111
in memory or persist to a simple, portable database file.
1212
Its lightweight design makes it an ideal candidate for an embedded database in
1313
portable (CLI) applications, test environments and much more.
14-
This library provides you a simple API to work with your SQLite database from within PHP.
14+
This library provides a simple API to work with your SQLite database from within PHP.
1515
Because working with SQLite and the underlying filesystem is inherently blocking,
1616
this project is built as a lightweight non-blocking process wrapper around it,
1717
so you can query your data without blocking your main application.
@@ -135,7 +135,7 @@ success or will reject with an `Exception` on error. The SQLite extension
135135
is inherently blocking, so this method will spawn an SQLite worker process
136136
to run all SQLite commands and queries in a separate process without
137137
blocking the main process. On Windows, it uses a temporary network socket
138-
for this communication, on all other platforms it communicates over
138+
for this communication, on all other platforms, it communicates over
139139
standard process I/O pipes.
140140

141141
```php
@@ -218,7 +218,7 @@ will not have to wait for an actual underlying connection.
218218

219219
Depending on your particular use case, you may prefer this method or the
220220
underlying `open()` method which resolves with a promise. For many
221-
simple use cases it may be easier to create a lazy connection.
221+
simple use cases, it may be easier to create a lazy connection.
222222

223223
The `$filename` parameter is the path to the SQLite database file or
224224
`:memory:` to create a temporary in-memory database. As of PHP 7.0.10, an
@@ -254,7 +254,7 @@ $db = $factory->openLazy('users.db', null, ['idle' => 0.1]);
254254
### DatabaseInterface
255255

256256
The `DatabaseInterface` represents a connection that is responsible for
257-
comunicating with your SQLite database wrapper, managing the connection state
257+
communicating with your SQLite database wrapper, managing the connection state
258258
and sending your database queries.
259259

260260
#### exec()
@@ -435,14 +435,14 @@ This project follows [SemVer](https://semver.org/).
435435
This will install the latest supported version:
436436

437437
```bash
438-
$ composer require clue/reactphp-sqlite:^1.1
438+
$ composer require clue/reactphp-sqlite:^1.2
439439
```
440440

441441
See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
442442

443443
This project aims to run on any platform and thus only requires `ext-sqlite3` and
444444
supports running on legacy PHP 5.4 through current PHP 8+.
445-
It's *highly recommended to use PHP 7+* for this project.
445+
It's *highly recommended to use the latest supported PHP version* for this project.
446446

447447
This project is implemented as a lightweight process wrapper around the `ext-sqlite3`
448448
PHP extension, so you'll have to make sure that you have a suitable version

src/Factory.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ public function __construct(LoopInterface $loop = null, $binary = null)
7979
* is inherently blocking, so this method will spawn an SQLite worker process
8080
* to run all SQLite commands and queries in a separate process without
8181
* blocking the main process. On Windows, it uses a temporary network socket
82-
* for this communication, on all other platforms it communicates over
82+
* for this communication, on all other platforms, it communicates over
8383
* standard process I/O pipes.
8484
*
8585
* ```php
@@ -181,7 +181,7 @@ public function open($filename, $flags = null)
181181
*
182182
* Depending on your particular use case, you may prefer this method or the
183183
* underlying `open()` method which resolves with a promise. For many
184-
* simple use cases it may be easier to create a lazy connection.
184+
* simple use cases, it may be easier to create a lazy connection.
185185
*
186186
* The `$filename` parameter is the path to the SQLite database file or
187187
* `:memory:` to create a temporary in-memory database. As of PHP 7.0.10, an

0 commit comments

Comments
 (0)