Skip to content

Latest commit

 

History

History
67 lines (48 loc) · 2.38 KB

README.md

File metadata and controls

67 lines (48 loc) · 2.38 KB

react-goodreads

react-goodreads is a React-component for Goodreads read shelf.

Build Status npm npm npm demo Quality Gate Status Maintainability Rating Security Rating

1. Install

npm install --save react-goodreads

2. Usage

Grab your Goodreads developer's key from here .

Component support responsive design with pure css.

https://cors-anywhere.herokuapp.com/ used for cors (Goodread does not support cors yet.) (year 2018?)

import React, { Component } from 'react';
import GoodReads from 'react-goodreads';

class App extends Component {
  render() {
    return (
      <div className="App">
        <header className="App-header">
        <GoodReads apikey="yourApiKey"/>
        </header>
      </div>
    );
  }
}

export default App;

3. Props

Props Default isRequired
apikey null Y
caption 'My Goodreads Read Shelf' N
bookCoverTitle 'Book Cover' N
bookNameTitle 'Book Name' N
startAtTitle 'Started At' N
ratingTitle 'Rating' N
locales 'en-EN' N

4. TODO

  • Custom styling

LICENSE

MIT@habil.