README says package.json is not needed, also, in the USAGE section, only run the command readme. However it gives this error

⠋ Gathering project infosreadme [template]

Generate README.md from a template

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

Options:
  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]

{ Error: ENOENT: no such file or directory, open 'package.json'
  errno: -2,
  code: 'ENOENT',
  syscall: 'open',
  path: 'package.json' }

This option would work as the --yes option of npm init : https://docs.npmjs.com/cli/init

Skip user interaction with CLI an take all default values to generate the README

You should publish a thin wrapper package named create-markdown-md with a small bin script. Due to the create-* convention it would qualify as a proper "initializer package".
This would allow usage via npm init readme-md or yarn create readme-md without prior installation.

I'd even go further and name it create-readme.md for a totally awesome yarn create readme.md :)

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,

It would be cool to be able to pre-fill the different fields when a README.md already exists. We would be able to modify the readme without making a new one from scratch.

Keep up the great work.

npm installl

output is :

npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules\fsevents):
npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"win32","arch":"x64"})

audited 866857 packages in 14.515s
found 0 vulnerabilities

The problem:

Some platforms (like bitbucket) does not support HTML tags in markdown. See #60

Solution:
The solution would be to create a second template named no-html that generates the same README content as the default one, but without HTML tags.

When you start the command npx readme-md-generator, it would display the list of available template, and you would be able to choose the one you want (use inquirer list for this feature) :

Example :

npx readme-md-generator
? Choose a template
> default.md (the default readme-md-generator template)
  default-no-html (the default readme-md-generator template without html tags)

Doesnt work on my golang proejct. Interested in PRs to extend ?

Hi,

First of all, thank you for your awesome work 👍

There is a section about author. This would be cool to have a section about contributors too. all-contributors is a specification about recognizing contributors. They also have a tool that edit README.md to add contributors.

For formatting code there is EditorConfig (https://editorconfig.org/) which is supported in all major IDE's (including the ones from JetBrains) and Visual Studio Code through the means of a plugin (ext install EditorConfig.EditorConfig).

The format of the file is straightforward, and can cover all files that are used/will be used. For example, something similar with the following can be used on your code:

[*]
charset=utf-8
end_of_line=lf
insert_final_newline=true
indent_style=space
indent_size=2

If you think it's a good idea, I can create a PR with this feature.

npx readme-md-generator

output is:
npx: installed 114 in 41.99s
Unexpected token (

What do you think about a session Available Scripts?
Getting all your scrpts commands on package.json file. Like generated apps with create-react-app.

If is ok I can try to do this.

A project like this seems like a good candidate for use via npx.

It might be worthwhile to note in the "Installation" section of the README that this project can be run with npx readme-md-generator. (I've tested this, and it already seems to work)

Thanks for your work on this, it's a great template for making READMEs. 😄👍

Looks like a utf bug, when you setup a new readme, in the "Install command" line, setting something with "&" will result in "&amp" in the final readme.

On gitlab:

On bitbucket

same project

It's all messed up until the description after the tags :/

 <h1><p><h1 align="center">Welcome to XXX 👋</h1> <p> <a href="https://twitter.com/XXX"> <img alt="Twitter: XXX" src="https://img.shields.io/twitter/follow/XXX.svg?style=social" target="_blank" /> </a> </p>```

Tried out your project on my MacBook Pro (Mojave macOs 10.14.5). After successfully installing using your notes, I attempted to run and get the following error:

usr/local/lib/node_modules/readme-md-generator/src/cli.js:14
const askQuestions = async projectInfos => {
                           ^^^^^^^^^^^^
SyntaxError: Unexpected identifier
    at Object.exports.runInThisContext (vm.js:76:16)
    at Module._compile (module.js:528:28)
    at Object.Module._extensions..js (module.js:565:10)
    at Module.load (module.js:473:32)
    at tryModuleLoad (module.js:432:12)
    at Function.Module._load (module.js:424:3)
    at Module.require (module.js:483:17)
    at require (internal/module.js:20:19)
    at Object.<anonymous> (/usr/local/lib/node_modules/readme-md-generator/src/index.js:5:25)
    at Module._compile (module.js:556:32)

Which is interesting as I can clearly see the require statement

const projectInfos = require('./project-infos')

And project-infos.js appears to be fine.
Not knowledgable enough in node to debug it further myself.

The user could use its own ejs template by specifying the path.

Example :

npx readme-md-generator -t path/to/my/own/template.md 

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.

Hello, I've tested on GitLab and I saw that they are using a different flavor of Markdown and other rules for embedding HTML.

The default generated HTML looks like this right now on GitLab:

But if the Markdown is written as:

<div align="center">

# Test
</div>
<p>
  <img src="https://img.shields.io/badge/version-2.0-blue.svg?cacheSeconds=2592000" />
</p>

it looks correct:

You could use view command to test if a package exists on npm:

npm view [package]

If it exists you can use npm version badge instead of generic one. An another improvement would be to let user add a tag to point on a specific version channel. For example 2.0.0-alpha.1