1001Ferramentas
Tools Categories Guides FAQ
About Contact Privacy Policy Terms of Use
📘Dev

README.md Generator

Build a professional README.md filling in name, description, badges, install, usage, license. Markdown preview side-by-side.

Badges
Gerenciador de pacotes
README.md 

  


  






    
    
    

      

        
        

          
Create a professional README

          
          
          

            
The README is a project's business card on GitHub, yet facing the blank file freezes a lot of people. This generator walks you through building a complete README.md, leaving you to just fill in the sections that matter.

            
It lays out the essential blocks (name, description, badges, installation instructions, usage examples and licence) and shows a preview of the rendered Markdown right alongside, so you follow the result as you write. Rather than straining to remember each part's syntax, you get to focus on the content.

            
Generation happens in the browser, ready for you to copy straight into the project root. A polished README counts for a lot in the first impression of anyone landing on the repository.

          

        

        
        
        
        

          
Frequently asked questions

          

            
            

              Which sections go into the generated README?
              
The file comes out with the title (project name), whichever badges you tick (license, npm and build), the description, an Installation section holding the command of the package manager you picked (npm install, pnpm add or yarn add), a Usage section wrapping your example code in a js block — it only shows up when the field has content — and the License, chosen from MIT, Apache-2.0, GPL-3.0, BSD-3-Clause and Unlicense. An empty name falls back to the default meu-projeto; an empty description is simply left out.

            

            
            

              Do the generated badges actually work?
              
It depends on the badge. The license and build ones are static shields.io images: the build badge always reads passing and stays decorative until you swap in your real CI URL. The npm badge is live, though — it looks up the published version of the package under the name you typed, so it works for real as long as the package exists on the npm registry. The tool never validates any of them, it just writes the Markdown with those URLs — and since the images come from shields.io, the badges need internet access to show up.

            

            
            

              Does the panel show rendered Markdown or the raw source?
              
The raw source — exactly the text that goes inside README.md, refreshed on every keystroke. There is no rendered preview, so to see how GitHub will display it, paste the result into an editor with a preview pane or straight into the repository. The Copy button puts the whole thing on the clipboard in one go, with no confirmation message; after that, create a README.md at the project root and paste. Heads up: the section headings come out in Portuguese (Instalação, Uso, Licença), so rename them if your repo speaks English.

            

            
          

        

        
      

    

    
    
    
    
    

      



  
Related Tools

  

    
      
  

    📑
    

      
Markdown TOC Generator

      
Generate the table of contents of a Markdown file from headings (#, ##, ###). Includes GitHub-style anchors. Everything in your browser.

    

  



    
      
  

    📝
    

      
Markdown Cheatsheet

      
Quick reference for Markdown syntax, filterable by keyword: headings, lists, links, tables, code and more. Shows the raw syntax next to what it does.

    

  



    
      
  

    📋
    

      
Markdown Table Generator

      
Build Markdown tables visually — add rows and columns, edit cells and copy the GFM syntax ready for README, Notion or GitHub. No manual formatting.

    

  



    
      
  

    ⚙️
    

      
GitHub Actions Generator

      
Generate YAML workflows for GitHub Actions: Node CI, static deploy, semver release, lint+test. Customize triggers and steps. Everything in your browser.

    

  



    
      
  

    🌳
    

      
ASCII Tree Generator

      
Paste an indented structure (spaces/tabs) and generate an ASCII tree ready for README — ├──, └── etc. Everything in your browser.

    

  



    
      
  

    📖
    

      
Storybook main.js Generator

      
Generate the .storybook/main.js for Storybook 7+ with React and Vite, ready to use. Copy the config and start documenting your components in minutes.