From bfba65f934d78b497857f2f52be7e300f064e952 Mon Sep 17 00:00:00 2001 From: Markus Felten Date: Fri, 22 Dec 2017 22:47:30 +0100 Subject: [PATCH] doc: switch to documentation --- README.md | 14 ++++++++++++++ doc/README.hbs | 21 --------------------- doc/jsdoc.json | 10 ---------- 3 files changed, 14 insertions(+), 31 deletions(-) delete mode 100644 doc/README.hbs delete mode 100644 doc/jsdoc.json diff --git a/README.md b/README.md index d08c36da..50e37f76 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,17 @@ bitbucket-repository-provider === repository provider for bitbucket + +# API + +# install + +With [npm](http://npmjs.org) do: + +```shell +npm install bitbucket-repository-provider +``` + +# license + +BSD-2-Clause diff --git a/doc/README.hbs b/doc/README.hbs deleted file mode 100644 index 9c7a84a7..00000000 --- a/doc/README.hbs +++ /dev/null @@ -1,21 +0,0 @@ -[![npm](https://img.shields.io/npm/v/bitbucket-repository-provider.svg)](https://www.npmjs.com/package/bitbucket-repository-provider) -[![Greenkeeper](https://badges.greenkeeper.io/arlac77/bitbucket-repository-provider.svg)](https://greenkeeper.io/) -[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/arlac77/bitbucket-repository-provider) -[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) -[![Build Status](https://secure.travis-ci.org/arlac77/bitbucket-repository-provider.png)](http://travis-ci.org/arlac77/bitbucket-repository-provider) -[![bithound](https://www.bithound.io/github/arlac77/bitbucket-repository-provider/badges/score.svg)](https://www.bithound.io/github/arlac77/bitbucket-repository-provider) -[![codecov.io](http://codecov.io/github/arlac77/bitbucket-repository-provider/coverage.svg?branch=master)](http://codecov.io/github/arlac77/bitbucket-repository-provider?branch=master) -[![Coverage Status](https://coveralls.io/repos/arlac77/bitbucket-repository-provider/badge.svg)](https://coveralls.io/r/arlac77/bitbucket-repository-provider) -[![Known Vulnerabilities](https://snyk.io/test/github/arlac77/bitbucket-repository-provider/badge.svg)](https://snyk.io/test/github/arlac77/bitbucket-repository-provider) -[![GitHub Issues](https://img.shields.io/github/issues/arlac77/bitbucket-repository-provider.svg?style=flat-square)](https://github.com/arlac77/bitbucket-repository-provider/issues) -[![Stories in Ready](https://badge.waffle.io/arlac77/bitbucket-repository-provider.svg?label=ready&title=Ready)](http://waffle.io/arlac77/bitbucket-repository-provider) -[![Dependency Status](https://david-dm.org/arlac77/bitbucket-repository-provider.svg)](https://david-dm.org/arlac77/bitbucket-repository-provider) -[![devDependency Status](https://david-dm.org/arlac77/bitbucket-repository-provider/dev-status.svg)](https://david-dm.org/arlac77/bitbucket-repository-provider#info=devDependencies) -[![docs](http://inch-ci.org/github/arlac77/bitbucket-repository-provider.svg?branch=master)](http://inch-ci.org/github/arlac77/bitbucket-repository-provider) -[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo) -[![downloads](http://img.shields.io/npm/dm/bitbucket-repository-provider.svg?style=flat-square)](https://npmjs.org/package/bitbucket-repository-provider) -[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) - -bitbucket-repository-provider -=== -repository provider for bitbucket diff --git a/doc/jsdoc.json b/doc/jsdoc.json deleted file mode 100644 index 137f4c28..00000000 --- a/doc/jsdoc.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "plugins": [ - "node_modules/jsdoc-babel" - ], - "babel": { - "presets": [ - "env" - ] - } -} \ No newline at end of file