Skip to content

Commit

Permalink
docs: update section about package manager methods some more
Browse files Browse the repository at this point in the history
  • Loading branch information
G-Rath committed Aug 17, 2023
1 parent 47a52ec commit a263f19
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,14 +103,19 @@ exists without the property.
> TODO: providing a class
Managers are provided a reference to the `PackageJson` when they're initialized,
are run in the same directory as that `PackageJson`, and lets you do the
following:

> **Note**
>
> Unless otherwise noted, options are safe to use regardless of what underlying
> package manager is being used; if an option is not supported by a particular
> package manager, it will be ignored
are run in the same directory as that `PackageJson`, and lets you do a series of
common actions defined below.

Unless otherwise noted for a particular method, each method:

- Behaves like `system`, returning either `true`, `false`, or `nil` based on if
the package manager exited with a non-zero error code; each method has a
bang-equivalent if you wish an exception to be thrown instead
- Does not attempt to capture or intercept the output; using `Kernel.system`
under the hood, output is sent directly to `stdout` and `stderr`
- Can be passed any of the options listed for the particular method regardless
of what underlying package manager is being used; if an option is not
supported by the manager, it will be ignored

### Installing dependencies

Expand Down

0 comments on commit a263f19

Please sign in to comment.