Write more detailed documentation

[edharkhimich]

The documentation that the library has is a bit abstract in my opinion. I was try to compare it with 'samples' that it has in github repo and found it misleading.
There are couple examples:

• In 'zeroconf' example you clone the "com.acme.somelib:somelib1:0.0" project without 'gitRepositories' block in 'settings.gradle' file. Doesn't work on my end
• In your documentation example you're not mention that one of this 2 options - 'branch' or 'tag' are required :
  gitRepositories { include('jdoctor') { uri = '[email protected]:melix/jdoctor.git' // optional, set what branch to use branch = 'feature1' // you can also use a tag tag = 'v1.0' } }
  On my end module without specifying one of this options won't be loaded.
• When I set a tag in 'gitRepositories' block, in 'build.gradle' library version number won't be readable.
  implementation "com.somelib:client" will work without specifying the version number
  And in case when I enter the wrong version number it won't even give me an error

implementation "com.somelib:client:5.10" - the version number which is not exist

• I don't know how for others but for it doesn't work in my pipeline but compile without any problems on my local machine

// settings.gradle
rootProject.name = sample

gitRepositories { include('client') { uri = '[email protected]:melix/jdoctor.git' tag = '1.0' } }
include ":sample-client"

// build.gradle
implementation "com.somelib:sample-client"

Thank you in advance