gatsby-source-circleci/README.md

Source plugin for [CircleCI's API](https://circleci.com/docs/api/#circleci-api-reference-guide).

# gatsby-source-circleci

Source plugin for [CircleCI's API](https://circleci.com/docs/api/#circleci-api-reference-guide).

_**Please Note:** This plugin was initially created to deliver data for my [dashboard](https://status.lekoarts.de/) and hence only queries the user and projects. If you need more functionality, I'd be happy to review your PR and merge it into this plugin!_

## Install

```shell
npm install --save gatsby-source-circleci
```

## How to use

### Prerequisites

Go to [Account dashboard](https://circleci.com/account/api) and create a new API token.

Save the API key in an environment file like:

```
CIRCLECI_KEY=your-api-token-here
```

### gatsby-config

Add the plugin and define the API key.

```js
module.exports = {
  plugins: [
    {
      resolve: 'gatsby-source-circleci',
      options: {
        apiKey: process.env.CIRCLECI_KEY,
      }
    }
  ]
}
```