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

@appcominteractive/writeme

v1.0.4

Published

This is an interactive generator for creating readme files according to the appcom readme styleguide

Downloads

13

Vulnerabilities

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

Links

Git

Maintainers

appcominteractiveadminappcominteractiveadminblackfadedblackfadedjsproedejsproededasheck0dasheck0phlpphlp

Keywords

readmegeneratorappcomstyleguide

Readme

Write me!

License

This is an interactive generator for creating readme files according to the appcom readme styleguide. You can use it to create a basic README.me file for your project (i.e. module/library, solution, styleguide).

Usage

After installation you can run

writeme

and the interactive generator will start. After completing it your README.md file is created and you can edit it to your liking.

For skipping the interactive process entirely you can provide the type parameter. See API section for more information on parameters.

writeme --type=module

API

Usage: writeme [options]

This is an interactive generator for creating readme files according to the appcom readme styleguide

Options: -V, --version output the version number -t, --type [type] Set the type of software the readme is refering to (currently supported: module, solution, styleguide) (default: "") -n, --name [name] Set the name of the software (default: "") -d, --dir [dir] Set the directory where the readme is placed (default: ".") -h, --help output usage information

Installation

You can install this tool by running

npm i -g @appcominteractive/writeme

It requires you to have npm and node installed.

Contributing

Bug reports and pull requests are welcome on GitHub at {URL}. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

Copyright 2019 appcom interactive GmbH

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.