Capacity to read a pom.xml to generate the README

[bbonnin]

For old guys like me, that still develop with Maven, it would be great to generate the README.md from a pom.xml instead of a package.json file.

• New command line option: -x

readme -x

• The pom.xml must contain some informations such as:

<project>
    <name>My Great Project</name>
    <description>Some useful description</description>
    <url>http://example.com</url>

    <contributors>
        <contributor>
            <name>Bob</name>
        </contributor>
    </contributors>

    <licenses>
        <license>
            <name>MIT</name>
        </license>
    </licenses>

    <issueManagement>
        <url>http://example.com/issues</url>
    </issueManagement>
</project>

[kefranabg]

Thanks old man 😉 Cool feature! I'll do a review ASAP

[patou]

Why add an cli option, just search if there are a pom.xml or package.json

[bbonnin]

In some cases, on some very weird projects , you can have a pom.xml and package.json in the same directory ;)

[patou]

Just use a priority of use pom or package, or ask to use wich file use. For some project, you complexify the use of readme-generator.

[bbonnin]

I agree for asking which file to use, but never use a priority, it's error prone !! And by default, package.json will be read, so no complexity added

[codecov[bot]]

Codecov Report

Merging #142 into master will not change coverage. The diff coverage is 100%.

@@          Coverage Diff          @@
##           master   #142   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          25     27    +2     
  Lines         206    247   +41     
  Branches       23     30    +7     
=====================================
+ Hits          206    247   +41

Impacted Files	Coverage Δ
src/cli.js	100% <100%> (ø)	:arrow_up:
src/utils.js	100% <100%> (ø)	:arrow_up:
src/questions/source-file.js	100% <100%> (ø)
src/detect-source-file.js	100% <100%> (ø)
src/project-infos.js	100% <100%> (ø)	:arrow_up:

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 6ef3cd4...53cf808. Read the comment docs.

[bbonnin]

Remove option -x, add file detection and asking for which file to use in case of conflict