pesde-pkg/pesde
1
1
Fork 0
mirror of https://github.com/pesde-pkg/pesde.git synced 2025-05-04 02:23:51 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: update README

Browse source
This commit is contained in:
LukaDev 2024-10-22 18:24:42 +02:00
parent 3152e4534b
commit 265872c747
1 changed files with 20 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -6,21 +6,23 @@
<br>
pesde is a package manager for the Luau programming language, supporting multiple runtimes including Roblox and Lune.
pesde has its own registry, however it can also use Wally, and Git repositories as package sources.
It has been designed with multiple targets in mind, namely Roblox, Lune, and Luau.
pesde is a package manager for the Luau programming language, supporting
multiple runtimes including Roblox and Lune. pesde has its own registry, however
it can also use Wally, and Git repositories as package sources. It has been
designed with multiple targets in mind, namely Roblox, Lune, and Luau.
## Installation
pesde can be installed from GitHub Releases. You can find the latest
release [here](https://github.com/daimond113/pesde/releases). Once you have downloaded the binary,
run the following command to install it:
pesde can be installed from GitHub Releases. You can find the latest release
[here](https://github.com/daimond113/pesde/releases). Once you have downloaded
the binary, run the following command to install it:
```sh
pesde self-install
```
Note that pesde manages its own versions, so you can update it by running the following command:
Note that pesde manages its own versions, so you can update it by running the
following command:
```sh
pesde self-upgrade
@ -28,19 +30,23 @@ pesde self-upgrade
## Documentation
For more information about its usage, you can check the [documentation](https://docs.pesde.daimond113.com).
*Currently waiting on [this PR](https://github.com/daimond113/pesde/pull/3) to be merged.*
For more information about its usage, you can check the
[documentation](https://docs.pesde.daimond113.com).
## Registry
The main pesde registry is hosted on [fly.io](https://fly.io). You can find it at https://registry.pesde.daimond113.com.
The main pesde registry is hosted on [fly.io](https://fly.io). You can find it
at https://registry.pesde.daimond113.com.
### Self-hosting
The registry tries to require no modifications to be self-hosted. Please refer to the [example .env file](https://github.com/daimond113/pesde/blob/0.5/registry/.env.example) for more information.
The registry tries to require no modifications to be self-hosted. Please refer
to the
[documentation](http://docs.pesde.daimond113.com/guides/self-hosting-registries)
for more information.
## Previous art
pesde is heavily inspired by [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [Wally](https://wally.run),
and [Cargo](https://doc.rust-lang.org/cargo/).
pesde is heavily inspired by [npm](https://www.npmjs.com/),
[pnpm](https://pnpm.io/), [Wally](https://wally.run), and
[Cargo](https://doc.rust-lang.org/cargo/).