diff --git a/Installation.md b/Installation.md index 278f514..de900c3 100644 --- a/Installation.md +++ b/Installation.md @@ -1,20 +1,30 @@ -# Pre-Requisites - -Imperfectly, **Loom Spinner CLI** requires the following tools installed on your system: - -- PHP 8.3+ -- [Composer](https://getcomposer.org/download/) -- [Docker Engine](https://www.docker.com/) - Either with Docker Desktop or CLI. - # Installation -> Please note, this will not yet work as this package is currently unreleased. +Welcome! This guide will help you set up **Loom Spinner CLI** on your system. -To install **Loom Spinner CLI**, use the following Composer command: +## Prerequisites + +Before installation, make sure the following are installed: + +- **PHP 8.3 or newer** +- [Composer](https://getcomposer.org/download/) +- [Docker Engine](https://www.docker.com/) (Docker Desktop or Docker CLI) + +> **Note:** Loom Spinner CLI is currently unreleased. Installation steps will become available once the package is published. + +## Install Loom Spinner CLI + +Once Loom Spinner CLI is released, you will be able to install it globally with Composer: ```shell composer global require loomlabs/loom-spinner-cli ``` -This will download the package and add the command to your global Composer `bin` directory, so you can call `loom` -commands on your machine. \ No newline at end of file + +This command downloads Loom Spinner CLI and adds it to your global Composer `bin` directory, making the `loom` command +available anywhere in your terminal. + +--- + +If you run into any trouble or need additional guidance, check out the [Quick Start Guide](Quick-Start-Guide) or the +other sections in this documentation. \ No newline at end of file