fix: Correct Example Section in README

Jonathan Bowerequested to merge
gitlab-community/gitlab-org/api/client-go:2253-README-examples into main

Fixes the issue noted in #2253 (closed), specifically with the README linking to an examples directory that no longer exists.

I updated it to provide a brief note trying to encapsulate why Examples are provided the way that they are, and added a note below the examples in the README to look at the example_* files in the project for more.

Let me know what you think, I'm definitely open to adjusting this if needed 😄

Merge request reports