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

@redeagle/readme-template

v1.0.3

Published

This is a small template README.md file for your projects!

Downloads

6

Vulnerabilities

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

Links

Git

Maintainers

redeagleredeagle

Keywords

boilerplatereadmeREADME.mddocsstartkittemplatefront enddocumentation

Readme

Table of Contents

Intro

Writing the Readme is an integral part of writing a good program. Until you can put your thought in writing, you still can’t start writing code.

There must be a middle ground between the piles of technical specification papers and its absence, as such. And in fact it is. This golden mean is an inconspicuous and modest Readme file.

Consider the process of writing the Readme file for your project as a true act of creation. This is exactly the place where all your brilliant ideas should be expressed.

Getting started

Npm&Yarn install:

#Nostalgic
$ npm install @redeagle/readme-template

#Hipster
$ yarn add @redeagle/readme-template

Clone the repo:

Clone the repo to get all source files as they are available on Github:

$ git clone https://github.com/redeagleap/readme-template.git

$ cd readme-template/

⇧ back to top

Features

For the header of our README.md, we will use HTML markup to centralize the information. Like this:

These tags are used to better navigate the file:

⇧ back to top

Usefull links

For the badges:

For markdown:

For Github:

For create awesome code pictures for your docs:

Like this:

⇧ back to top

License

This project is licensed under the MIT License - see the LICENSE file for details.

⇧ back to top

Author

Readme Template made with love.
---------------------------------------
Author : Alexander Prisyazhnyuk

Email : [email protected]

Github : https://github.com/redeagleap/readme-template.git

forthebadge

⇧ back to top