Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci(packages): enable greenkeeper #3

Merged
merged 4 commits into from
Apr 9, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 30 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `readme-inspector` [![NPM version][npm-image]][npm-url]

> <img align="left" alt="markdown" height="50" width="50" src="https://cdnjs.cloudflare.com/ajax/libs/octicons/4.4.0/svg/markdown.svg"> Inspect GitHub (and GitHub Enterprise) repositories for the presence and quality of READMEs.
> <img align="middle" alt="markdown" height="50" width="50" src="https://cdnjs.cloudflare.com/ajax/libs/octicons/4.4.0/svg/markdown.svg"> Inspect GitHub (and GitHub Enterprise) repositories for the presence and quality of READMEs.

[![The MIT License][license-image]][license-url]
[![FOSSA Status][fossa-image]][fossa-url]<br>
Expand All @@ -14,10 +14,23 @@
[![NPMS score][npms-image]][npms-url]
[![NPM downloads per month][npm-downloads-month]][npm-url]

## Table of contents

<!-- ⛔️ AUTO-GENERATED-CONTENT:START (TOC:excludeText=Table of contents) -->
- [Installation](#installation)
- [Usage](#usage)
- [API](#api)
* [`ScoreMe`](#scoreme)
* [`ReadmeInspector`](#readmeinspector)
- [Version](#version)
- [Contributing](#contributing)
- [License](#license)
<!-- ⛔️ AUTO-GENERATED-CONTENT:END -->

## Installation

`readme-inspector` is written in JavaScript (CommonJS) for
[Node.js ![External link][icon-octicon-link-external]](https://nodejs.org/) versions 6 or higher.
> ![info][icon-octicon-info] `readme-inspector` is written in JavaScript (CommonJS) for
> [Node.js ![External link][icon-octicon-link-external]](https://nodejs.org/) versions 6 or higher.

```sh
$ npm install --save readme-inspector
Expand Down Expand Up @@ -82,6 +95,12 @@ const results = await inspector.check()

## API

### `ScoreMe`

An API proxy for [@clayallsopp ![External link][icon-octicon-link-external]](https://github.com/clayallsopp)'s [`readme-score-api` ![External link][icon-octicon-link-external]](https://github.com/clayallsopp/readme-score-api).

### `ReadmeInspector`

## Version

[![NPM version][npm-image]][npm-url]
Expand Down Expand Up @@ -129,6 +148,13 @@ Before embarking on a significant change, please adhere to the following guideli

MIT © [commonality](https://github.com/commonality)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fcommonality%2Freadme-inspector.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fcommonality%2Freadme-inspector?ref=badge_large)

---

[![Greenkeeper badge](https://badges.greenkeeper.io/commonality/readme-inspector.svg)](https://greenkeeper.io/)
[![Readme Score](http://readme-score-api.herokuapp.com/score.svg?url=https://github.com/commonality/readme-inspector)](http://clayallsopp.github.io/readme-score?url=https://github.com/commonality/readme-inspector)

<!-- ⛔️ Link References ⛔️ -->

[bunyan-format-url]: https://github.com/thlorenz/bunyan-format/#readme
Expand All @@ -141,7 +167,7 @@ MIT © [commonality](https://github.com/commonality)
<!-- ⛔️ CI Services ⛔️ -->

[notice-url]: https://app.fossa.io/reports/07123904-7d26-40a6-b6af-c74e82a53789
[appveyor-image]: https://img.shields.io/appveyor/ci/commonality/readme-inspector.svg?style=flat-square&logo=appveyor&label=windows%20build
[appveyor-image]: https://img.shields.io/appveyor/ci/gregswindle/readme-inspector.svg?style=flat-square&logo=appveyor&label=windows%20build
[appveyor-url]: https://ci.appveyor.com/project/commonality/readme-inspector
[codacy-image]: https://img.shields.io/codacy/grade/21f517a2d5bf4304895f40c5cbb596c4.svg?style=flat-square
[codacy-coverage-image]: https://img.shields.io/codacy/coverage/21f517a2d5bf4304895f40c5cbb596c4.svg?style=flat-square
Expand Down
20 changes: 20 additions & 0 deletions appveyor.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
environment:
matrix:
- nodejs_version: '9'
- nodejs_version: '8'
- nodejs_version: '7.6.0'
install:
- ps: Install-Product node $env:nodejs_version
- npm i npm@latest -g
- npm install
matrix:
fast_finish: true
build: off
shallow_clone: true
clone_depth: 1
test_script:
- node --version
- npm --version
- cd %APPVEYOR_BUILD_FOLDER%
- npm run test:config
- npm test