diff --git a/README.md b/README.md index f34b0f2..14f11d0 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,26 @@ Spinners for the console. ## Install -Install using composer. +Recommended is to install using composer. Add the repository to your global +`~/.config/composer/config.json` file: + +``` +{ + "repositories": [ + { + "type": "composer", + "url": "https://dev.noccylabs.info/api/packages/noccy/composer" + } + ] +} +``` + +Then add the package as a dependency: + +``` +$ composer require noccylabs/spinner +``` + ## Usage @@ -32,3 +51,11 @@ while(true) { usleep(10000); } ``` + +### Included styles + +Style | Width | Notes +---|---|--- +`BrailleDotStyle` | 1 | A snake chasing its tail, new "docker compose" style +`RollingBallStyle` | 1 | A rolling ball, "symfony new" style +`SpinnerStyle` | 2 | four-part spinner, 2 characters wide