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

https://github.com/arshadkazmi42/npm-badger

Auto inject badges markdown in README.md
https://github.com/arshadkazmi42/npm-badger

badges github markdown npm npm-badges readme repository

Last synced: 6 months ago
JSON representation

Auto inject badges markdown in README.md

Awesome Lists containing this project

README

          

# npm-badger

[![Build](https://github.com/arshadkazmi42/npm-badger/actions/workflows/nodejs.yml/badge.svg)](https://github.com/arshadkazmi42/npm-badger/actions/workflows/nodejs.yml)
[![NPM Version](https://img.shields.io/npm/v/npm-badger.svg)](https://www.npmjs.com/package/npm-badger)
[![NPM Downloads](https://img.shields.io/npm/dt/npm-badger.svg)](https://www.npmjs.com/package/npm-badger)
[![Github Repo Size](https://img.shields.io/github/repo-size/arshadkazmi42/npm-badger.svg)](https://github.com/arshadkazmi42/npm-badger)
[![LICENSE](https://img.shields.io/npm/l/npm-badger.svg)](https://github.com/arshadkazmi42/npm-badger/blob/master/LICENSE)
[![Contributors](https://img.shields.io/github/contributors/arshadkazmi42/npm-badger.svg)](https://github.com/arshadkazmi42/npm-badger/graphs/contributors)
[![Commit](https://img.shields.io/github/last-commit/arshadkazmi42/npm-badger.svg)](https://github.com/arshadkazmi42/npm-badger/commits/master)

Auto inject markdown badges of NPM and Github in README.md of current directory.

## Install

```
npm install npm-badger -g
```

## Usage

```bash

$ cd my-github-repository-folder
$ npm-badger

✔ Badges injected sucessfully!

```

## Contributing

Interested in contributing to this project?
You can log any issues or suggestion related to this library [here](https://github.com/arshadkazmi42/npm-badger/issues/new)

Read our contributing [guide](CONTRIBUTING.md) on getting started with contributing to the codebase