docs: expand package README with comprehensive documentation (#11)

* docs: Initial plan

* docs: add comprehensive package README for NetEvolve.CodeBuilder

Co-authored-by: samtrion <[email protected]>

* fix: Moved README to root

* docs: complete API reference with all available methods and overloads

Co-authored-by: samtrion <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: samtrion <[email protected]>
Co-authored-by: Martin Stühmer <[email protected]>

Author: Copilot