Hi!

I am asking the user about the package manager in the project-info.js file after checking for package.json. Please let me know if there is a better place to put that question.

Thank you.

Describe the bug Sometimes the username can itself contain markdown characters and it would render improperly. We need to escape markdown character for it to actually render the correct username.

For example:

* Twitter: [@__anku__](https://twitter.com/__anku__)

renders as

• Twitter: @anku

expected output

• Twitter: @__anku__

To Reproduce Use markdown characters while entering username/email.

I am not exactly sure how to solve this but I think we need to create a function that will escape all markdown characters and use that function to sanitize user input.

I would like to take a shot at this :)

If a package.json is detected, readme-md-generator should ask to choose between yarn and npm. It would allow suggest install, usage and test command with correct package manager (instead of always using npm)

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>

When I try to use the "readme" command it returns this error that I may have found in several Issue on other repo but none of the solutions are useful here :

⠋ Gathering project infosreadme [template]

Generate README.md from a template

Positionals:
  template  The name of template you want to use             [défaut: "default"]

Options:
  --version  Affiche le numéro de version                              [booléen]
  --help     Affiche de l'aide                                         [booléen]

TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received type undefined
    at validateString (internal/validators.js:107:11)
    at Object.basename (path.js:1149:5)
    at module.exports (/usr/local/lib/node_modules/readme-md-generator/node_modules/project-name/index.js:8:47)
    at Object.getProjectInfos (/usr/local/lib/node_modules/readme-md-generator/src/project-infos.js:106:16)
    at async mainProcess (/usr/local/lib/node_modules/readme-md-generator/src/cli.js:46:31)

Thank you !

Hi!

This PR fixes #168

I had to rename contributingUrl to issuesUrl first and then I used contributingUrl for the contributing guide link.

Please take a look and suggest any changes if required. Thank you 🙂

Describe the bug

After the readme is generated, the process does not exit so we can't go back to the shell.

To Reproduce

1. Clone project
2. Remove package-lock.json and node_modules (I think the problem is that when package is globally installed with npm, lock file is not used)
3. Run npm start
4. Answer questions
5. The process does not quit after the readme is generated

Describe the bug Static badge generation not working when license name contains special characters. Example Apache-2

To Reproduce Steps to reproduce the behavior:

• In your package.json, add "license": "Apache-2"
• Run readme generator
• Fill license url

Expected behavior A clear and concise description of what you expected to happen.

Should display a license badge in README with Apache-2 but we get a 404.

Additional context Add any other context about the problem here.

The issue come from shields.io that cannot contains special characters in url. readme-md-generator should skip special chars in license name.

When there is a license name but no license URL, we will show the license badge with href=#.

Example Image:

I ran the tests and all tests are passing.

If it is not the desired fix, please let me know and I will update my PR accordingly.

Thank you.

Hello!

I juste updated readme-md-generator to version 0.6.0 and it seems there is the .git directory that has been added to the package. That implies that when when we try to do a npm install when readme-md-generator is already installed, we got the following error:

npm ERR! path node_modules/readme-md-generator
npm ERR! code EISGIT
npm ERR! git node_modules/readme-md-generator: Appears to be a git repo or submodule.
npm ERR! git node_modules/readme-md-generator
npm ERR! git Refusing to remove it. Update manually,
npm ERR! git or move it out of the way first.

To reproduce it, simply install [email protected], install it and than try to do an other npm install

Have a good day!

Le Poulet Suisse

When i execute, it's locked in second question "project version (use empty value to skip)".I can not type anything and I have to close the terminal.

Is your feature request related to a problem? Please describe. I use the ssh remote format for many of my cloned github repos.

An example of this format is:

git clone [email protected]:kefranabg/readme-md-generator.git

As you can see in this function below...

https://github.com/kefranabg/readme-md-generator/blob/f0370c8efe602bfc1e1334ea556214de4c1b0f04/src/project-infos.js#L76-L82

Where GITHUB_URL is defined as

https://github.com/kefranabg/readme-md-generator/blob/f0370c8efe602bfc1e1334ea556214de4c1b0f04/src/project-infos.js#L14

The check for if a local project is a github project clone only handles git-over-https.

Describe the solution you'd like An expansion to treat git-over-ssh on the github url as the same as the equivalent git-over-https

Describe alternatives you've considered Unsure.

Additional context ...

Describe the solution you'd like Support Image For Showcase Program

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.

The command line program generates bad links.

To Reproduce Steps to reproduce the behavior:

1. When prompted for to add a link the link will be entered with // between https: and the second level domain (website name)

Expected behavior Should return the url as entered

Screenshots

Desktop (please complete the following information):

• OS: Mac 12.01

Fixed some language issues like metadata is one word. And "suggest you" is poor English so "suggest ... to you"

Fixed up links to be local absolute paths and point license badge to license section.

Resolving issue #205

Ask a new question to set the changelog url. By default, it takes the base url of the repository and get a file named : "CHANGELOG.md"

In the same time, I have updated the copyright year to 2021 for passing all the test.