Skip to content

Commit 2ddbc79

Browse files
authored
Update README.md and DEVELOPER.md for packagist (#39)
Add instructions for using packagist to install the pie package Signed-off-by: James Duong <[email protected]>
1 parent 28b34cf commit 2ddbc79

File tree

2 files changed

+58
-2
lines changed

2 files changed

+58
-2
lines changed

DEVELOPER.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,35 @@ pip3 install ziglang
109109
cargo install --locked cargo-zigbuild
110110
```
111111

112-
#### Building and installation steps
112+
#### Installing from Packagist
113+
You can use pie to install the extension from the Packagist repository.
114+
See: https://packagist.org/packages/valkey-io/valkey-glide-php
115+
116+
Before starting this step, make sure you've installed all dependencies above.
117+
118+
Additionally, you will need to install the pie tool.
119+
120+
On Linux, you can download pie with curl. eg:
121+
```bash
122+
curl -L https://github.com/php/pie/releases/latest/download/pie.phar -o pie
123+
chmod +x pie
124+
sudo mv pie /usr/local/bin/pie
125+
export PATH="$PATH:/usr/local/bin"
126+
```
127+
128+
On MacOS, install with Homebrew:
129+
```bash
130+
brew install pie
131+
```
132+
133+
To install the Valkey Glide extension, simply use the pie command:
134+
```bash
135+
# VERSION can be set to any release tag or branch at https://github.com/valkey-io/valkey-glide-php.git
136+
export VERSION=1.0.0
137+
pie install valkey-io/valkey-glide-php:$VERSION
138+
```
139+
140+
#### Steps for building and installing from source
113141

114142
Before starting this step, make sure you've installed all software requirements.
115143

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,35 @@ export PATH="$PATH:$HOME/.local/bin"
118118
protoc --version
119119
```
120120

121-
### Building and Installing the Extension
121+
### Installing from Packagist
122+
You can use pie to install the extension from the Packagist repository.
123+
See: https://packagist.org/packages/valkey-io/valkey-glide-php
124+
125+
Before starting this step, make sure you've installed all dependencies above.
126+
127+
Additionally, you will need to install the pie tool.
128+
129+
On Linux, you can download pie with curl. eg:
130+
```bash
131+
curl -L https://github.com/php/pie/releases/latest/download/pie.phar -o pie
132+
chmod +x pie
133+
sudo mv pie /usr/local/bin/pie
134+
export PATH="$PATH:/usr/local/bin"
135+
```
136+
137+
On MacOS, install with Homebrew:
138+
```bash
139+
brew install pie
140+
```
141+
142+
To install the Valkey Glide extension, simply use the pie command:
143+
```bash
144+
# VERSION can be set to any release tag or branch at https://github.com/valkey-io/valkey-glide-php.git
145+
export VERSION=1.0.0
146+
pie install valkey-io/valkey-glide-php:$VERSION
147+
```
148+
149+
### Building and Installing the Extension from source
122150

123151
1. Clone the repository:
124152
```bash

0 commit comments

Comments
 (0)