README.md
# Config
[![Build][build-badge]][build-url]
[![Code Climate Test Coverage][code-climate-coverage-badge]][code-climate-coverage-url]
[![Code Climate Maintainability][code-climate-maintainability-badge]][code-climate-maintainability-url]
[![License][license-badge]][license-url]
[![npm version][npm-version-badge]][npm-version-url]
[![npm bundle size \(minified\)][npm-minified-badge]][npm-minified-url]
[![npm bundle size \(minified, zipped\)][npm-minified-minzipped-badge]][npm-minified-minzipped-url]
> A shareable config for all Colonise packages.
### Overview
Simply put, this repository is designed to be used by all packages that we make with TypeScript in the Colonise organisation.
### Documentation
Full documentation can be found under [documentation][documentation-url], or by looking for the identically named Markdown file adjacent to each source file.
### Want to contribute?
That's great! We'd love to see what suggestions you have.
[Read the contributing guide.][contributing-url]
### Open Source
Config is part of Colonise's Open Source Software, and is made with love by the Colonise team.
[![Colonise Logo][colonise-logo]][colonise-url]
### [License][license-url]
[documentation-url]: /documentation/README.md
[contributing-url]: /CONTRIBUTING.md
[colonise-logo]: /documentation/assets/colonise256.png
[colonise-url]: https://colonise.org/
[build-badge]: https://img.shields.io/github/actions/workflow/status/colonise/config/nodejs-master.yml?branch=master
[build-url]: https://github.com/Colonise/Config/actions/workflows/nodejs-master.yml?query=workflow%3A%22Node.js+CI%22
[code-climate-coverage-badge]: https://img.shields.io/codeclimate/coverage/Colonise/Config.svg
[code-climate-coverage-url]: https://codeclimate.com/github/Colonise/Config
[code-climate-maintainability-badge]: https://img.shields.io/codeclimate/maintainability-percentage/Colonise/Config.svg
[code-climate-maintainability-url]: https://codeclimate.com/github/Colonise/Config
[license-badge]: https://img.shields.io/github/license/Colonise/Config.svg
[license-url]: https://github.com/Colonise/Config/blob/master/LICENSE
[npm-version-badge]: https://img.shields.io/npm/v/@colonise/config.svg
[npm-version-url]: https://www.npmjs.com/package/@colonise/config
[npm-minified-badge]: https://img.shields.io/bundlephobia/min/@colonise/config.svg
[npm-minified-url]: https://bundlephobia.com/result?p=@colonise/config
[npm-minified-minzipped-badge]: https://img.shields.io/bundlephobia/minzip/@colonise/config.svg
[npm-minified-minzipped-url]: https://bundlephobia.com/result?p=@colonise/config