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

@ayobami6/readme-generate

v1.1.1

Published

Generate a detialed readme with AI

Downloads

1

Vulnerabilities

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

Links

Maintainers

ayobami6ayobami6

Keywords

readmegenerateaiopenaiopenai-apiclicommand-line

Readme

Readme Generator

Languages GitHub repo size GitHub issues GitHub closed issues GitHub pull requests GitHub GitHub Repo stars GitHub forks GitHub contributors npm version

Generate a detail and organized README.md file for your project using the command line with just simple prompt.

Usage

  • Install the package globally
npm install -g @ayobami6/readme-generate
  • Export your openai api key as an environment variable
export OPENAI_API_KEY=your_api_key
  • Run the command
readme-generate
  • Answer the prompt and your README.md file will be generated in the current directory.

https://github.com/Ayobami6/readme-generate/assets/91608325/f559bcc6-0842-4b36-8750-4c13b8b804ea

Development Setup

  • Clone the repository
git clone <url>
  • cd into the project directory
cd readme-generate
  • Install dependencies
npm install or make install
  • Run the script
node index.js or make run

Contributing

Contributions, issues and feature requests are welcome! feel free to check issues page

Show your support

If you find this project useful, please give it a ⭐️!

📝 License

This project is MIT licensed.