diff --git a/README.md b/README.md index 730c402..43df0ff 100755 --- a/README.md +++ b/README.md @@ -1,15 +1,30 @@ # @nodewell/brand +[![GitHub Release][badge-github]][url-github] +[![Travis CI][badge-travis]][url-travis] [![ISC License][badge-license-isc]][url-license-doc-isc] [![CC-BY-4.0 License][badge-license-cc]][url-license-doc-cc4] +[![Style Guide][badge-style]][url-style] +[![Release Workflow][badge-release]][url-release] +[![PRs Welcome][badge-contrib]][url-contrib-doc] + +The official brand of [**@nodewell**][url-homepage]. + +## Assets + +| Type | Asset | +| ---- | ---------------------------------------------------------------------------------------- | +| Logo | ![logo](dist/logo.svg) | +| Lead | ![lead](dist/github-lead.svg) | +| | ........................................................................................ | ## Colors - - nodewell green: **#69b247** - - ![#69b247][color-nodewell-green] + - nodewell green: **#69B247** + - ![#69B247][color-nodewell-green] - - nodewell gray: **#424345** - - ![#424345][color-nodewell-gray] + - nodewell gray: **#424344** + - ![#424344][color-nodewell-gray] ## License @@ -23,22 +38,33 @@ the [**CC-BY-4.0**][url-license-cc4] license. - [![CC-BY-4.0][image-cc4]][url-license-doc-cc4] @ [Richard King](www.richrdkng.com) - + - [badge-license-isc]: https://img.shields.io/badge/license-ISC-blue.svg - [badge-license-cc]: https://img.shields.io/badge/license-CC--BY--4.0-blue.svg + [badge-github]: https://img.shields.io/github/release/nodewell/brand.svg?style=social + [badge-travis]: https://img.shields.io/travis/nodewell/brand.svg?style=flat-square + [badge-style]: https://img.shields.io/badge/style-standardjs-f3df49.svg?style=flat-square + [badge-release]: https://img.shields.io/badge/release-semantic--release-e10079.svg?style=flat-square + [badge-license-isc]: https://img.shields.io/badge/license-ISC-blue.svg?style=flat-square + [badge-license-cc]: https://img.shields.io/badge/license-CC--BY--4.0-blue.svg?style=flat-square + [badge-contrib]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square - [color-nodewell-green]: https://img.shields.io/badge/-%2369b247-69b247.svg?style=for-the-badge - [color-nodewell-gray]: https://img.shields.io/badge/-%23424345-424345.svg?style=for-the-badge + [color-nodewell-green]: https://img.shields.io/badge/-%2369B247-69B247.svg?style=for-the-badge + [color-nodewell-gray]: https://img.shields.io/badge/-%23424344-424344.svg?style=for-the-badge - [image-cc4]: https://i.creativecommons.org/l/by/4.0/80x15.png + [image-cc4]: https://i.creativecommons.org/l/by/4.0/88x31.png + [url-github]: https://github.com/nodewell/brand + [url-travis]: https://travis-ci.org/nodewell/brand + [url-style]: https://standardjs.com + [url-release]: https://semantic-release.gitbook.io/semantic-release [url-license-doc]: LICENSE.md - [url-license-doc-isc]: LICENSE.md#isc-license - [url-license-doc-cc4]: LICENSE.md#creative-commons-attribution-40-international-public-license + [url-license-doc-isc]: https://github.com/nodewell/brand/blob/master/LICENSE.md#isc-license + [url-license-doc-cc4]: https://github.com/nodewell/brand/blob/master/LICENSE.md#creative-commons-attribution-40-international-public-license + [url-contrib-doc]: CONTRIBUTING.md [url-license-isc]: https://choosealicense.com/licenses/isc/ [url-license-cc4]: http://creativecommons.org/licenses/by/4.0/ + [url-homepage]: https://github.com/nodewell