mirror of
https://github.com/ivabus/pantry
synced 2024-09-20 00:30:48 +03:00
Document providers
This commit is contained in:
parent
ed424f9307
commit
e63148f269
13
README.md
13
README.md
|
@ -64,6 +64,18 @@ $ gh pr create
|
|||
While inside a pantry dev-env you can run commands from any built packages
|
||||
provided you specified their `provides:` key.
|
||||
|
||||
## Providers
|
||||
|
||||
If the package you want to add to tea can be executed simply eg. you want
|
||||
`foo` to run `npx foo`, then you can add a one-line entry to
|
||||
[`npmjs.com/provider.yml`].
|
||||
|
||||
We currently also support this for `pipx`. Adding support for other such
|
||||
dependency manager execution handlers is easy and welcome.
|
||||
|
||||
At this time, if the package has tea dependencies or requires compilation,
|
||||
it should be packaged as a `package.yml`.
|
||||
|
||||
## Packaging Guide
|
||||
|
||||
Packaging can be cumbersome.
|
||||
|
@ -98,3 +110,4 @@ $ pkg edit
|
|||
[wiki]: https://github.com/teaxyz/pantry/wiki
|
||||
[discussion]: https://github.com/orgs/teaxyz/discussions
|
||||
[IPFS]: https://ipfs.tech
|
||||
[`npmjs.com/provider.yml`]: ./projects/npmjs.com/provider.yml
|
||||
|
|
Loading…
Reference in a new issue