Pkg
Stats

npm package discovery and stats viewer.

Discover Tips

General search
[free text search, go nuts!]
Package details
pkg:[package-name]
User packages
@[username]

Sponsor

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.

Twitter
@PkgStats
GitHub
pkgstats
Twitter
@ryanhefner
GitHub
ryanhefner
Site
ryanhefner.com

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 🙏

Framework
react / react-dom
Server
next / express / next-routes
Data Store
redux / react-redux / next-redux-wrapper / redux-thunk / redux-logger
Caching
lru-cache
CSS / Styling
next-page-transitions / styled-components
Typeface
@ibm/plex
Avatars
gravatar
Data Viz
chart.js / react-sparklines
Date formatting
dayjs
Infinite scrolling
react-scroll-trigger
Markdown rendering
react-markdown
Repository url parsing
hosted-git-info
User data
npm-user
Compiling
babel-plugin-module-resolver / babel-plugin-styled-components
Types
prop-types
Odds & Ends
es6-promise / isomorphic-fetch

© 2024 – Pkg Stats / Ryan Hefner

@glamboyosa/create-readmes

v1.0.5

Published

2 years ago

A CLI that adds template READMEs to tru.ID devx example GitHub projects

Downloads

16

0High
0Medium
0Low

cli create-readmes

CREATE-READMES

CREATE-READMES is a Node.js CLI that adds template READMEs to new projects.

Motivation

Dev Exp. example repos @ tru.ID tend to have a somewhat consistent README file so I felt it necessary to automate the boilerplate away

Tools

Node.js
TypeScript

Installation

To install run:

npx @glamboyosa/create-readmes
#or
npm i -g @glamboyosa/create-readmes
#or
npm init @glamboyosa/create-readmes

Getting Started

If you want to use the CLI locally, clone this repo via:

git clone https://github.com/glamboyosa/create-readmes.git

Restore dependencies via:

yarn
# or
npm install

Start the project via:

cd dist && npm link

Finally, run the command:

create-readmes

Adapting for your organization

It is possible, if you're a DXer or DevRel'er you could very well be in the same position and as such need to create your own CLI tool off of this.

Detailed steps to reproduce for your organization are as follows:

Fork the repository, clone and restore dependencies.
Update the root package.json file, specifically name, version (set to 1.0.0), author & description
Follow the Getting Started guide in order to get it up and running.
Head over to src/cli.ts, line 5, the questions array and update the choices and default keys to values that suit your needs.
Head over to templates and update the folder names to reflect the changes in the choices field.
Publish to npm via npm publish