Skip to content

Commit 58dbb72

Browse files
committed
Bug #11, Fix to description in README & composer.json [iet:3634843]
* modified
1 parent c1df991 commit 58dbb72

2 files changed

Lines changed: 18 additions & 12 deletions

File tree

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# composer-suggest
44

5-
A [Composer plugin][] to install [suggestions][] simply, based on keyword patterns. _([Caution](#caution))_
5+
A [Composer plugin][] to install a custom selection of [suggested][] packages, based on keyword patterns. _([Caution](#caution))_
66

77

88
Example `composer.json`:
@@ -21,16 +21,20 @@ Example `composer.json`:
2121

2222
## Usage
2323

24-
```bash
25-
# 1. Set an environment variable containing a pattern/keywords in a .env file
26-
echo 'NF_COMPOSER_SUGGEST="(EXP|LACE)"' > .myenv
24+
1. Set an environment variable containing a pattern/keywords in a .env file,
25+
```bash
26+
echo 'NF_COMPOSER_SUGGEST="(EXP|LACE)"' > .env
27+
```
2728

28-
# 2. Require the plugin
29-
composer require nfreear/composer-suggest:dev-master
29+
2. Require the plugin,
30+
```
31+
composer require nfreear/composer-suggest
32+
```
3033

31-
# 3. Install as you would normally
32-
composer -vvv install
33-
```
34+
3. Install as you would normally (verbose),
35+
```
36+
composer -vvv install
37+
```
3438

3539

3640
## Legacy
@@ -80,6 +84,7 @@ Use of composer-suggest implies that you probably won't commit `composer.lock` t
8084
8185
Developed for the [LACE Evidence Hub][], part of the [Learning Analytics Community Exchange][] project.
8286
87+
Inspired by and based in part on the [composer-merge-plugin][] – thank you!
8388
8489
---
8590
License: [MIT][]
@@ -94,7 +99,7 @@ License: [MIT][]
9499
[composer-suggest]: https://github.com/nfreear/composer-suggest
95100
[Composer plugin]: https://getcomposer.org/doc/articles/plugins.md
96101
[Composer script]: https://getcomposer.org/doc/articles/scripts.md
97-
[suggestions]: https://getcomposer.org/doc/04-schema.md#suggest
102+
[suggested]: https://getcomposer.org/doc/04-schema.md#suggest
98103
[Institute of Educational Technology]: http://iet.open.ac.uk/
99104
[Learning Analytics Community Exchange]: http://www.laceproject.eu "LACE project"
100105
[LACE Evidence Hub]: http://evidence.laceproject.eu/
@@ -103,3 +108,4 @@ License: [MIT][]
103108
[say]: https://blog.engineyard.com/2014/composer-its-all-about-the-lock-file "Engineyard blog"
104109
[bad]: http://stackoverflow.com/questions/12896780/should-composer-lock-be-committed-to-version-c.. "Stackoverflow"
105110
[beware]: http://en.wiktionary.org/wiki/caveat_emptor "'User beware'"
111+
[composer-merge-plugin]: https://github.com/wikimedia/composer-merge-plugin

composer.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "nfreear/composer-suggest",
3-
"description": "Composer plugin to install suggestions simply, based on keyword patterns. $ vi .env && composer install $ \n(Developed via LACE project)",
4-
"keywords": [ "Composer", "suggest", "pattern", "regex", "LACE", "OpenUniversity", "IET-OU" ],
3+
"description": "Composer plugin to install a custom selection of suggested packages, based on keyword patterns. $ vi .env && composer install $",
4+
"keywords": [ "suggest", "pattern", "regex", "LACE", "OpenUniversity", "IET-OU" ],
55
"type": "composer-plugin",
66
"license": "MIT",
77
"minimum-stability": "dev",

0 commit comments

Comments
 (0)