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

syncano-socket-readme-generator

v1.0.0

Published

Generates a Github readme file from a Syncano socket.yml spec

Downloads

1

Vulnerabilities

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

Links

Git

Maintainers

adamwardeckiadamwardecki

Keywords

Readme

Syncano Socket Readme Generator

This CLI tool was created for Syncano Socket developers. It will let you generate a README.md file out of the Syncano socket.yml spec. Currently, the supported socket.yml properties are:

  • Config
  • Classes
  • Endpoints

And basic keys: name, description and version.

Usage

npx s-readme socket.yml

The README.md file will be generated in the current working directory. In case a README.md file already exists in the directory, the tool will ask to overwrite it.

Tests

To run tests:

npm run test

or with watch:

npm run test:watch

End to end tests use a sample test.yml file located in assets folder to generate a markdown file for comparison. Use the test.yml as a reference point or create another one for e2e test variations.