Added installation instructions to Readme (#6)

Co-authored-by: pavel <[email protected]>

Author: C5uJl

CHANGELOG.md

@@ -1,8 +1,14 @@
 # Shell Orchestration CLI changelog
+
 All notable changes to so-sli will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.2]
+
+- Added installation instructions to Readme
+
 ## [0.0.1]
+
 - Initial release

README.md

@@ -1,8 +1,23 @@
 # Shell Orchestration CLI
 
-Documentation is available at https://so-cli.dev.
+## Requirements
 
-# How to install?
-1. Install composer and ensure `$HOME/.composer/vendor/bin` includes in PATH variable.
-2. Install so-cli package as a global dependency: `composer global require systemseed/so-cli`.
-3. Run `so` in terminal to display all existing commands.
+- PHP >= 8.2
+- Composer [available in your console](https://getcomposer.org/doc/03-cli.md#composer-home)
+
+## How to install
+
+1. Install so-cli package as a global dependency: `composer global require systemseed/so-cli`
+2. Run `so --version` to verify that so-cli is installed correctly 
+3. Start using so-cli by printing list of available commands: `so list`
+
+## How to contribute
+
+1. Clone git repository and install dependencies:
+   ```
+   git clone [email protected]:systemseed/so-cli.git
+   cd so-cli
+   composer install
+   chmod +x so
+   ```
+2. Run `so --version` to verify that so-cli is installed correctly

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "systemseed/so-cli",
     "description": "Shell Orchestration CLI",
-    "version": "0.0.1",
+    "version": "0.0.2",
     "require": {
         "symfony/console": "^7.0",
         "symfony/yaml": "^7.0",

so

@@ -4,6 +4,7 @@
 use SoCli\CommandManager;
 use SoCli\Command\PullCommands;
 use Symfony\Component\Console\Application;
+use Composer\InstalledVersions;
 
 // The code related to autoloading was copied from https://github.com/drush-ops/drush/blob/13.x/drush.php.
 
@@ -36,6 +37,8 @@ if (!$loader) {
 }
 
 $application = new Application();
+$application->setName('Shell Orchestration CLI');
+$application->setVersion(InstalledVersions::getVersion('systemseed/so-cli'));
 $application->addCommands([
   new PullCommands(),
 ]);