pesde/README.md

47 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

2024-03-16 16:31:27 +00:00
<br>
<div align="center">
<img src="https://raw.githubusercontent.com/daimond113/pesde/0.5/assets/logotype.svg" alt="pesde logo" width="200" />
2024-03-16 16:31:27 +00:00
</div>
<br>
2024-03-04 20:18:49 +00:00
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.
2024-03-04 20:18:49 +00:00
## Installation
2024-07-12 23:09:37 +01:00
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:
2024-03-16 16:31:27 +00:00
```sh
pesde self-install
2024-03-16 16:31:27 +00:00
```
Note that pesde manages its own versions, so you can update it by running the following command:
2024-03-16 16:31:27 +00:00
```sh
pesde self-upgrade
```
2024-03-16 16:31:27 +00:00
2024-04-03 20:16:21 +01:00
## 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.*
2024-04-03 20:16:21 +01:00
2024-03-04 20:59:19 +00:00
## Registry
2024-03-04 20:18:49 +00:00
2024-03-04 20:59:19 +00:00
The main pesde registry is hosted on [fly.io](https://fly.io). You can find it at https://registry.pesde.daimond113.com.
2024-03-04 20:18:49 +00:00
2024-03-16 16:31:27 +00:00
### 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.
2024-03-16 16:31:27 +00:00
2024-03-04 20:18:49 +00:00
## Previous art
2024-07-12 23:09:37 +01:00
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/).