diff --git a/README.md b/README.md index 85c10e28..ce7e6acc 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@

- CircleCI Pipeline Status + CircleCI Code Climate maintainability @@ -13,12 +13,6 @@ CodeCov test coverage - - Dependency Status - - - Dev Dependency Status - Auto @@ -29,30 +23,9 @@ Licence: MIT - -

- - Core: Install Size: Core - -

-

- - Node: Install Size: Node - -

-

- - Browser Install Size: Browser - -

-

- - CLI Install Size: CLI - -

-🤖 [GitLab](https://gitlab.com/gitlab-org/gitlab/) API NodeJS library with full support of all the [Gitlab API](https://gitlab.com/gitlab-org/gitlab/tree/master/doc/api) services. +[GitLab](https://gitlab.com/gitlab-org/gitlab/) API NodeJS library with full support of all the [Gitlab API](https://gitlab.com/gitlab-org/gitlab/tree/master/doc/api) services. ## Table of Contents @@ -67,11 +40,9 @@ - [Custom Request Libraries](#custom-request-libraries) - [Misc](#misc) - [Debugging](#debugging) -- [Development](#development) - [Testing](#testing) - [Contributors](#contributors) -- [License](#license) -- [Changelog](#changelog) +- [Sponsors](#sponsors) ## Install @@ -501,33 +472,6 @@ fs.writeFileSync('test.zip', bufferedData); ## Debugging Depending on the library used, the full information about the request error can be a bit obfuscated. Ideally, the entire information is returned from Ky (browser) or Got (nodejs) however for simplicity, a description property is added to the error object that has the error message attached. Simply look for e.description to have a better idea of what the error actually is. -## Development - -To get this running locally rather than from your `node_modules` folder: - -```bash -$ git clone https://github.com/jdalrymple/gitbeaker.git -$ cd gitbeaker -$ yarn install -$ yarn build -``` - -And then inside whatever project you are using `gitbeaker` in you change your references to use that repo. In your package.json of that upstream project change: - -```json -"dependencies": { - "gitlab": "5.0.0" -} -``` - -to this - -```json -"dependencies": { - "gitlab": "" -} -``` - ## Testing Testing is a work-in-progress right now but here is the start. @@ -699,10 +643,17 @@ This started as a fork from [node-gitlab-legacy](https://github.com/node-gitlab/ - [Seb0uil](https://github.com/seb0uil) - [Dylan Taylor](https://github.com/dylanmtaylor) -## License +## Sponsors -[MIT](https://github.com/jdalrymple/gitbeaker/blob/master/LICENSE.md) - -## Changelog - -[Here](https://github.com/jdalrymple/gitbeaker/blob/master/CHANGELOG.md) +
+

+ + Special thanks for helping support this project: + +

+
+ + + +
+