diff --git a/README.md b/README.md index 723874c..7db4e13 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,21 @@ Just a stupidly fast Entity Component System - Cache friendly [archetype/SoA](https://ajmmertens.medium.com/building-an-ecs-2-archetypes-and-vectorization-fe21690805f9) storage - Rigorously [unit tested](https://github.com/Ukendio/jecs/actions/workflows/ci.yaml) for stability +### Installation + +With [Wally](https://wally.run/): +```bash +jecs = "ukendio/jecs@0.6.0" # Inside wally.toml +``` +With [pesde](https://pesde.dev/): +```bash +pesde add wally#ukendio/jecs@0.6.0 +``` +With [npm](https://www.npmjs.com/package/@rbxts/jecs) ([roblox-ts](https://roblox-ts.com/)): +```bash +npm i @rbxts/jecs +``` + ### Example ```lua diff --git a/docs/learn/overview.md b/docs/learn/overview.md index 9047a01..55c4f1f 100644 --- a/docs/learn/overview.md +++ b/docs/learn/overview.md @@ -2,6 +2,23 @@ Jecs is a standalone entity-component-system module written in Luau. ECS ("entity-component-system") describes one way to write games in a more data oriented design. +## Installation + +Jecs supports the following installation methods using package managers: +:::code-group +```bash [wally] +jecs = "ukendio/jecs@0.6.0" # Inside wally.toml +``` +```bash [pesde] +pesde add wally#ukendio/jecs@0.6.0 +``` +```bash [npm] +npm i @rbxts/jecs +``` +::: + +Additionally an `rbxm` is published with [each release under the assets submenu](https://github.com/Ukendio/jecs/releases/latest). + ## Hello World, Entity and Component It all has to start somewhere. A world stores entities and their components, and manages them. This tour will reference it for every operation. :::code-group