Skip to content

docs: installability sweep — vcs install step, accurate ePHPm version, doc-drift fixes #2

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

Merged
luthermonson merged 1 commit into from
Sep 1, 2026
Merged

docs: installability sweep — vcs install step, accurate ePHPm version, doc-drift fixes #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 15 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,9 @@ KV store instead of a `flock()` + `fwrite()` against

- **PHP 8.2+** with `ext-session` (which is bundled with PHP — you
almost certainly already have it).
- **The ePHPm runtime** — the global `ephpm_kv_*` SAPI functions are
- **The ePHPm runtime** — any tagged release works (the `ephpm_kv_*`
SAPI functions this handler calls have shipped since ePHPm v0.1.0;
current release: v0.8.6). The functions are
registered by ePHPm's embedded PHP. Outside ePHPm,
`SapiKvOps::__construct()` throws fast so you know immediately that
you're not running where the handler can work. For development
Expand All @@ -81,8 +83,14 @@ var_dump(function_exists('ephpm_kv_get')); // expect bool(true)

## Install

ePHPm packages are distributed via their GitHub repositories, not
Packagist. Add this repo as a Composer `vcs` repository, then require
the package (`ephpm/session-handler` is tagged `v0.1.0`, so `^0.1`
resolves):

```bash
composer require ephpm/session-handler
composer config repositories.ephpm/session-handler vcs https://github.com/ephpm/session-handler
composer require ephpm/session-handler:^0.1
```

That's it. No framework deps, nothing else to pull in.
Expand All @@ -108,12 +116,12 @@ my-app/
```json
{
"name": "acme/my-app",
"repositories": [
{ "type": "vcs", "url": "https://github.com/ephpm/session-handler" }
],
"require": {
"php": "^8.2",
"ephpm/session-handler": "^0.1"
},
"autoload": {
"files": ["vendor/autoload.php"]
}
}
```
Expand Down Expand Up @@ -193,7 +201,8 @@ If your WordPress install doesn't already have a Composer-managed
```bash
cd /path/to/wordpress
composer init --no-interaction --name=site/wp
composer require ephpm/session-handler
composer config repositories.ephpm/session-handler vcs https://github.com/ephpm/session-handler
composer require ephpm/session-handler:^0.1
```

Then point the autoload include in the mu-plugin at that vendor path.
Expand Down
Loading