From 265872c74702767238f4d068280215d4bd740043 Mon Sep 17 00:00:00 2001 From: LukaDev <47296785+lukadev-0@users.noreply.github.com> Date: Tue, 22 Oct 2024 18:24:42 +0200 Subject: [PATCH] docs: update README --- README.md | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 5c9dddf..2fa94d5 100644 --- a/README.md +++ b/README.md @@ -6,21 +6,23 @@
-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/).