magento-hackathon / magento-composer-installer

Composer installer for Magento modules
210 stars 154 forks source link

Update README.md #52

Closed joshribakoff closed 10 years ago

joshribakoff commented 10 years ago

Removing parts of the example that have nothing to do with anything, and reiterating the important parts

Flyingmana commented 10 years ago

Even if it is not required for a valid composer.json, I see the license part as required for publishing own modules. For example Magento Connect forces an open source license by adding it there, so we should lead people here to define an (open source) license, too.

joshribakoff commented 10 years ago

Right as you say those parts don't "do" anything, so I assumed the whole section was not important. The goal of this project's readme should be to show how to use this project, not some other project. Removing ancillary details that aren't directly related to this project more clearly shows that the "type" setting is the one that is important. At the very least, we should keep what we have now, but add a bold footnote. I spent some time debugging why it didn't work, but it was not clear to me as it currently reads.

Flyingmana commented 10 years ago

We can talk about this again as soon as people know how to use composer itself.

For the rest, they should follow examples more strictly, then such a case like you had would not happen.

joshribakoff commented 10 years ago

Ok. FYI I was trying to retrofit your plugin into an existing project, with an existing composer.json - therefore replacing my existing composer.json with your example was not possible in a strict sense, and it wasn't clear to me which parts where important.