Skip to content

Commit

Permalink
Update readme and guides
Browse files Browse the repository at this point in the history
  • Loading branch information
roborourke authored and davidcole1340 committed Sep 30, 2022
1 parent b765726 commit b821052
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 8 deletions.
14 changes: 10 additions & 4 deletions crates/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ SUBCOMMANDS:
Generates stub PHP files for the extension
$ cargo php install --help
cargo-php-install
cargo-php-install
Installs the extension in the current PHP installation.
Expand Down Expand Up @@ -71,8 +71,11 @@ OPTIONS:
--release
Whether to install the release version of the extension
--yes
Bypasses the confirmation prompt
$ cargo php remove --help
cargo-php-remove
cargo-php-remove
Removes the extension in the current PHP installation.
Expand All @@ -97,8 +100,11 @@ OPTIONS:
Path to the Cargo manifest of the extension. Defaults to the manifest in the directory
the command is called
--yes
Bypasses the confirmation prompt
$ cargo php stubs --help
cargo-php-stubs
cargo-php-stubs
Generates stub PHP files for the extension.
Expand All @@ -120,7 +126,7 @@ OPTIONS:
--manifest <MANIFEST>
Path to the Cargo manifest of the extension. Defaults to the manifest in the directory
the command is called.
This cannot be provided alongside the `ext` option, as that option provides a direct
path to the extension shared library.
Expand Down
14 changes: 10 additions & 4 deletions guide/src/cargo-php.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ personally recommend for use in Visual Studio Code).

```text
$ cargo php stubs --help
cargo-php-stubs
cargo-php-stubs
Generates stub PHP files for the extension.
Expand All @@ -106,7 +106,7 @@ OPTIONS:
--manifest <MANIFEST>
Path to the Cargo manifest of the extension. Defaults to the manifest in the directory
the command is called.
This cannot be provided alongside the `ext` option, as that option provides a direct
path to the extension shared library.
Expand All @@ -130,7 +130,7 @@ so you are able to restore if you run into any issues.

```text
$ cargo php install --help
cargo-php-install
cargo-php-install
Installs the extension in the current PHP installation.
Expand Down Expand Up @@ -164,6 +164,9 @@ OPTIONS:
--release
Whether to install the release version of the extension
--yes
Bypasses the confirmation prompt
```

## Extension Removal
Expand All @@ -175,7 +178,7 @@ from your `php.ini` if present.

```text
$ cargo php remove --help
cargo-php-remove
cargo-php-remove
Removes the extension in the current PHP installation.
Expand Down Expand Up @@ -203,6 +206,9 @@ OPTIONS:
--manifest <MANIFEST>
Path to the Cargo manifest of the extension. Defaults to the manifest in the directory
the command is called
--yes
Bypasses the confirmation prompt
```

[`cargo-php`]: https://crates.io/crates/cargo-php
Expand Down

0 comments on commit b821052

Please sign in to comment.