Skip to content
This repository was archived by the owner on Jun 6, 2022. It is now read-only.

Commit 67ae282

Browse files
Improve documentation
1 parent b90f180 commit 67ae282

File tree

3 files changed

+42
-1
lines changed

3 files changed

+42
-1
lines changed

README.md

+40
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,43 @@
22

33
Magento 2 Downloader for Commerce & Open Source
44

5+
Download mage2me
6+
----------------
7+
8+
```bash
9+
curl -L https://github.com/improper/mage2me/releases/latest/download/mage2me --output mage2me
10+
chmod u+x ./mage2me
11+
./mage2me --version
12+
```
13+
14+
Download & Install Magento
15+
--------------------------
16+
17+
Some of the options shown below are indeed optional. Checkout `./mage2me --help` for more info.
18+
19+
```bash
20+
./mage2me output-directory \
21+
--mage-edition "Open Source" \
22+
--mage-version "2.3.5" \
23+
--github-token $GITHUB_TOKEN \
24+
--mage-access-key-public $MAGENTO_PUBLIC_KEY \
25+
--mage-access-key-private $MAGENTO_PRIVATE_KEY
26+
27+
cd magento-directory
28+
composer install
29+
```
30+
31+
List Download Options
32+
---------------------
33+
34+
```bash
35+
./mage2me --help
36+
```
37+
38+
39+
List Global Options
40+
-------------------
41+
42+
```bash
43+
./mage2me list
44+
```

bin/mage2me.php

+1
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@
77

88
$application = new Application('mage2me', 'v1.0.0');
99
$application->add(new DownloadCommand());
10+
$application->setDefaultCommand('download');
1011
$application->run();
1112

src/CommandTraits/MagentoVersionCommandTraits.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public function addOptionMageVersion()
3535
$this->keyMageVersion(),
3636
null,
3737
InputOption::VALUE_OPTIONAL,
38-
'Magento Edition',
38+
'Magento Edition. [2.1, 2.2, 2.3.5, 2.4-develop, ...]',
3939
'2.3.5'
4040
);
4141
}

0 commit comments

Comments
 (0)