npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

dynamic-readme-generator

v1.1.5

Published

The 'Dynamic README Generator' is a tool designed to simplify the creation of thorough and well-organized README files for software projects. It prompts users for essential information, such as project details, installation instructions, usage guidelines,

Downloads

5

Readme

W11-Dynamic-README-Generator

License GitHub language

Description

The "Dynamic README Generator" is a tool designed to simplify the creation of thorough and well-organized README files for software projects. It prompts users for essential information, such as project details, installation instructions, usage guidelines, licensing preferences, and more. The resulting README includes a table of contents for easy navigation, automatically formatted sections, and links to collaborators' GitHub profiles and emails. You can streamline and improve your project documentation by using this efficient README generation tool.

Table of Contents

Installation

Package

npm i dynamic-readme-generator --save-dev
yarn add dynamic-readme-generator --dev

GitHub

Follow these steps to install the Dynamic README Generator:

  1. Clone the repository. The URL of the GitHub repository
  2. Run 'npm install' to install dependencies.
  3. Call the generateREADME function in the index.js file
  4. Run the application using 'npm start'.
  5. Follow the prompts to provide project details.

Usage

If you installed via a package manager, just import the generateREADME function and call it in your desired js file, then run the file however you want

const generateREADME = require("dynamic-readme-generator");
generateREADME();

or

import generateREADME from "dynamic-readme-generator";
generateREADME();

If you followed the repo approach, run the application using the command 'npm start' in the terminal. Follow the interactive prompts to input your project details. The generator will create a README file based on your responses. Screenshot

For a visual walkthrough, watch it on the Google drive: https://drive.google.com/file/d/14Sn2vEiKDATYwP-RkELpf2TBitlOmRJB/view?usp=sharing. Or please refer to /assets/video/Walkthrough.mp4.

The walkthrough is divided into two parts:

  1. Usage Demonstration: This part provides a step-by-step demonstration of how to use the application.

  2. Handling N/A Sections: The second part illustrates how the application handles scenarios where some sections are marked as N/A (Not Applicable). Gain insights into the behavior when certain information is not provided.

License

MIT License

Features

  • Automated README generation
  • Interactive command-line interface
  • Support for multiple licenses

Tests

To run tests, use the command 'npm test'. Ensure that all tests pass before contributing to the project.

Questions

If you have any questions or need further clarification, feel free to open an issue or contact directly:

  • Celia's Email
  • Chisom's Email