1
0
Fork 0

[Doc] Explained a bit more about the possible contents of the "name" property

pull/6326/head
Javier Eguiluz 2017-04-05 09:15:06 +02:00
parent 3642fe63b2
commit 5f09df6070
1 changed files with 6 additions and 3 deletions

View File

@ -29,13 +29,16 @@ The config of dependencies is ignored. This makes the `config` field
### name
The name of the package. It consists of vendor name and project name,
separated by `/`.
Examples:
separated by `/`. Examples:
* monolog/monolog
* igorw/event-source
The name can contain any character, including white spaces, and it's case
sensitive (`foor/bar` is considered a different package than `Foo/Bar`). In order
to simplify its installation, it's recommended to define a short and lowercase
name that doesn't include non-alphanumeric characters or white spaces.
Required for published packages (libraries).
### description