Update README

[dlebauer]

It is currently missing a lot of useful information.

[shah0108]

i would like to work on this issue can u tell me what information must be added, if u can explain in brief i will make a pr and would update asap...

[dlebauer]

Hi @shah0108, thanks for your offer to help and interest! @Alomir is currently working on this, and this might not the easiest place for a new contributor to jump in.

If you are interested in contributing to documentation, we welcome your help! One place to start would be to annotate functions in sipnet.c using Doxygen markup. Hint: start with the smallest functions, or the ones that are already well commented and just need doxygen markup. (@Alomir may have suggestions).

But there is one more catch - @Alomir is currently reorganizing and restyling the code, which might cause merge conflicts if done before reorganization and styling changes are merged. But you could start writing the docs in a separate file and then paste them in after the merge.

[shah0108]

Ohh! Thanks for the clarification, I'd love to contribute to the documentation. I'll start by annotating functions in sipnet.c using Doxygen markup, and would focus more on well-commented ones first. I'll ensure my changes align with the reorganization. For the rest of the time, if there's any beginner-friendly issues i can work on please suggest, i would love to contribute!