ivabus/pantry
1
0
Fork 0
mirror of https://github.com/ivabus/pantry synced 2024-09-20 00:30:48 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document providers

Browse source
This commit is contained in:
Max Howell 2023-05-04 11:25:10 -03:00
parent ed424f9307
commit e63148f269
No known key found for this signature in database
GPG key ID: 741BB84EF5BB9EEC
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -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