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 🙏

© 2026 – Pkg Stats / Ryan Hefner

readmeg

v1.0.1

Published

Zero-config terminal tool powered by Gemini that automatically generates comprehensive, production-grade README files for local repositories.

Downloads

383

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

imtyroonimtyroon

Keywords

readmegeneratorgeminicliaidocumentation

Readme

Contributors Forks Stargazers Issues MIT License Twitter

About The Project

Product Name Screen Shot

Writing a comprehensive, high-quality README is often the most tedious part of finishing a project. readmeg solves this by automating the entire process.

By scanning your local repository structure, analyzing key manifest files (such as package.json, tsconfig.json, and .env.example), and leveraging the advanced contextual understanding of Google's Gemini AI, readmeg generates a production-grade, beautifully formatted README in seconds.

Here's why you should use readmeg:

  • Zero-Config: No complex setup or configuration files required.
  • Context-Aware: It parses your actual codebase structure and dependencies to write accurate documentation.
  • Interactive CLI: Prompts you for key details to customize the output to your exact needs.
  • Time-Saving: Instantly generates standard sections like Installation, Usage, Roadmap, and License.

Built With

  • Node.js
  • Gemini
  • TypeScript

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

  • Node.js (v18.0.0 or higher recommended)
  • Gemini API Key: You will need an API key from Google AI Studio.

Installation

  1. Clone the repository:
    git clone https://github.com/iamtyroon/readme-gen.git
  2. Navigate to the project directory and install dependencies:
    cd readme-gen
npm install
  3. Create a .env file in the root directory and add your Gemini API key:
    GEMINI_API_KEY="YOUR_GEMINI_API_KEY"
  4. Link the package globally to use the readmeg command anywhere:
    npm link

Usage

Once installed globally, you can run readmeg in any local repository to generate its documentation.

Run the Generator

Navigate to the target repository where you want to generate a README and run:

readmeg

Command Line Options

You can also view help and available options directly from the CLI:

readmeg --help

How It Works

  1. Codebase Scan: readmeg analyzes your directory tree and identifies key configuration files.
  2. Context Extraction: It extracts metadata, dependencies, and scripts from files like package.json and .env.example.
  3. AI Generation: The extracted context is sent to the Gemini API to draft a structured, professional README.md.
  4. Output: The generated markdown is saved directly to your workspace as README.md.

Roadmap

  • [ ] Support for additional language manifests (Cargo.toml, pyproject.toml, go.mod)
  • [ ] Custom template selection (e.g., Minimal, Academic, Enterprise)
  • [ ] Interactive terminal preview before writing to disk
  • [ ] GitHub Actions integration for automated documentation updates

See the open issues for a full list of proposed features and known issues.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

iamtyroon - @notyroon

Project Link: https://github.com/iamtyroon/readme-gen

Acknowledgments