Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ovhemert/npmcard

NPM Business Card
https://github.com/ovhemert/npmcard

Last synced: 21 days ago
JSON representation

NPM Business Card

Awesome Lists containing this project

README

        

# Your NPM Business Card

[![Travis](https://img.shields.io/travis/com/ovhemert/npmcard.svg?branch=master&logo=travis)](https://travis-ci.com/ovhemert/npmcard)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/d241a0808c5a450f94830a747d7e7b28)](https://www.codacy.com/app/ovhemert/npmcard?utm_source=github.com&utm_medium=referral&utm_content=ovhemert/npmcard&utm_campaign=Badge_Grade)
[![Known Vulnerabilities](https://snyk.io/test/npm/npmcard/badge.svg)](https://snyk.io/test/npm/npmcard)
[![Coverage Status](https://coveralls.io/repos/github/ovhemert/npmcard/badge.svg)](https://coveralls.io/github/ovhemert/npmcard)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)

Reads public information from your NPM profile.

![Example](./assets/images/example.png)

## Try it

``` sh
$ npx npmcard
```

It's that easy.

## Use it

Want to create and customize your own card? Use it as a module in you project.

``` sh
$ npm install npmcard
```

And use [this](https://github.com/ovhemert/npmcard-ovhemert/blob/master/bin/index.js) as an example. More docs will come, or help me write them by sending a PR ;)

## Maintainers

Osmond van Hemert
[![Github](https://img.shields.io/badge/-website.svg?style=social&logoColor=333&logo=github)](https://github.com/ovhemert)
[![Web](https://img.shields.io/badge/-website.svg?style=social&logoColor=333&logo=nextdoor)](https://ovhemert.dev)

## Contributing

If you would like to help out with some code, check the [details](./docs/CONTRIBUTING.md).

Not a coder, but still want to support? Have a look at the options available to [donate](https://ovhemert.dev/donate).

## Inspired by
[@bitandbang](https://www.npmjs.com/package/bitandbang)