[DOCS] Update repository readme file

spiral-modules / roadrunner-binary

💾 High-performance PHP application server, load-balancer and process manager written in Golang. RR2 releases repository.

MIT License

44 stars 25 forks source link

[DOCS] Update repository readme file #27

Closed tarampampam closed 3 years ago

tarampampam commented 3 years ago

The readme file in this repository needs to be updated. I mean:

Add information about "what is this and for a what?"
How to make changes to existing code, how to write and add plugins
How to run the application, what sub-commands and flags are available
Links to relevant repositories with php-worker, roadrunner core, etc
Description of the configuration process

@48d90782 What do you think?

rustatian commented 3 years ago

@tarampampam We have one source for the documentation. This is the roadrunner.dev site backed by the roadrunner-docs GitHub repository. I suppose, that we can put some explanation links here, where to find relative information (php-worker, roadrunner-core, etc). But most of these points are covered by the roadrunner.dev documentation except for the detailed information about new commands.