Skip to content

msmfa/github-repo-display-react

Repository files navigation

github-repo-display-react

A react component that displays your Github repos

NPM JavaScript Style Guide

Install

npm install --save github-repo-display-react

Usage

import React, { Component } from "react"

import { GithubRepoDisplay } from "github-repo-display-react"
import "github-repo-display-react/dist/index.css" // default github styling

const App = () => {
  return (
    <div>
      <GithubRepoDisplay
        numOfrepos={5} // must be included
        userName='msmfa' // must be included
      />
    </div>
  )
}

export default App

Configuration

...

const App = () => {
  return (
    <div>
      <GithubRepoDisplay
        numOfrepos={5}
        userName='msmfa'
        showStars={true} // displays stars
        showLanguage ={true} // displays language
      />
    </div>
  )
}

...

Screenshot

Below are the default styles (which mirror the github feed)

image

Styling

Use these id Tags to customise your component

image

License

MIT © MSMFA