search

yiisoft / injector

PSR-11 compatible injector
https://www.yiiframework.com/
BSD 3-Clause "New" or "Revised" License
43 stars 18 forks source link

Update introduction in README #23

Closed mikehaertl closed 4 years ago

mikehaertl commented 4 years ago

Suggestion for an updated intro and features in the README.

Rationale: I'm struggling a lot to follow many of the new Yii3 packages due to lacking/unclear docs (also inline). This is a first attempt to make it a bit easier for the newcomers. Feel free to ignore - or change again at a later time.

OT: Also started adding some inline docs mainly for myself - not sure if another PR is welcome. If so I'd definitely need more help/answers as a lot of code is unclear without comments.

samdark commented 4 years ago

@mikehaertl feel free to pull request additional docs. These are welcome. Inline comments may be a signal that the code could be refactored for better clarity or these could be alright (in case thing itself is meant to be complicated).

samdark commented 4 years ago

I've applied changes to diagrams and merged it. Thank you!

mikehaertl commented 4 years ago

@samdark Nice, thanks.

Minor note for the diagram: Without "yes"/"no" labels the diagram can not be read by color blind persons. (According to wikipedia 8% of the male population is affected by red/green blindness).

samdark commented 4 years ago

Adjusted in https://github.com/yiisoft/injector/commit/3a721341add2df148650e18397b1212dd9007156