react-contributors/README.md

A lightweight React component for displaying GitHub repository contributors

# react-contributors

> Small and simple React component to display a fully responsive list of your project's contributors with info gathered from their GitHub profile.

[![NPM](https://img.shields.io/npm/v/react-contributors.svg)](https://www.npmjs.com/package/react-contributors) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Demo

Live demo: <https://evert-arias.github.io/react-contributors/>

![demo](demo.png)

## Install

```bash
npm install --save react-contributors
```

## Usage

```jsx
import React, { Component } from "react";

// Import the component - styles are automatically included
import { Contributors } from "react-contributors";

// Username of the repo(s) owner.
const owner = "evert-arias";

// Repository name or array with multiple repositories names.
const repos = ["EasyButton", "easybtn.earias.me"];

class App extends Component {
  render() {
    return <Contributors owner={owner} repo={repos} />;
  }
}
```

You must pass the following two props to the component:

**owner**: Username of the repo(s) owner.

**repo**: Repository name or array with multiple repositories names

## License

MIT © [Evert Arias](https://github.com/evert-arias)