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

mvn-readme-md-generator

v1.2.8

Published

Maven ReadMe.md generator

Downloads

9

Readme

Maven Readme.md file generator

Run

npx mvn-readme-md-generator [args]

Description

        Maven readme.md file generator works by looking into the pom.xml 
    file and '/src/main/resources' properties directory to get project 
    meta-data that will be used in to the process. 
        The command line tool asks you some describing questions that will 
    be used as data for the readme.md file. Current implementation supports 
    generator functionality for maven projects with no sub modules. 
        In the next versions we will come with functionality for generating 
    Readme.md parent file that will reference all children readme.md generated 
    files from maven sub modules.     

Help

Args:
    --path: [string] custome .md template path to be used
    --propDir: [string] custome .properties/.yml files directory where meta-data 
    will be extracted
    --ymlProp: [boolean] looking for .yml prop files when extracts project meta-data

Usage:
    npx mvn-readme-md-generator - Run command with default arguments
    npx mvn-readme-md-generator 
    --path [custome-md-template-path] 
    --propDir [other-path-for-props-dir] 
    --ymlProp [true] - Run command with custome parameters
    

License & Copyright

MIT-Style License
Copyright (c) Pancu Daniel

codesquad-dev team