diff --git a/README.md b/README.md index f17f52253..b5ef1a7d7 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,11 @@ A minimal, responsive, and feature-rich Jekyll theme for technical writing. - [![CI](https://img.shields.io/github/actions/workflow/status/cotes2020/jekyll-theme-chirpy/ci.yml?logo=github)][ci]  - [![Codacy Badge](https://img.shields.io/codacy/grade/4e556876a3c54d5e8f2d2857c4f43894?logo=codacy)][codacy]  - [![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy?color=goldenrod)][license]  - [![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy?&logo=RubyGems&logoColor=ghostwhite&label=gem&color=orange)][gem]  - [![Open in Dev Containers](https://img.shields.io/badge/Dev_Containers-Open-deepskyblue?logo=linuxcontainers)][open-container] + [![CI][badge-ci]][ci]  + [![Codacy Badge][badge-codacy]][codacy]  + [![GitHub license][badge-license]][license]  + [![Gem Version][badge-gem]][gem]  + [![Open in Dev Containers][badge-open-container]][open-container] [**Live Demo** →][demo] @@ -45,28 +45,23 @@ For details, please refer to our [Contributing Guidelines][contribute-guide]. ## Credits -### Contributors +This project is built on the [Jekyll][jekyllrb] ecosystem and integrates a +collection of [excellent libraries][lib]. Its avatar and favicon are sourced +from [ClipartMAX][clipartmax]. -Thanks to [all the contributors][contributors] involved in the development of -the project! +Furthermore, thanks to everyone who contributed to the development of this project! -[![all-contributors](https://contrib.rocks/image?repo=cotes2020/jekyll-theme-chirpy&columns=16&max=112)][contributors] - — Made with [contrib.rocks](https://contrib.rocks) - -### Third-Party Assets - -This project is built on the [Jekyll][jekyllrb] ecosystem and integrates several -[great libraries][lib]. It is developed using [VS Code][vscode] and tools -provided by [JetBrains][jetbrains] under a non-commercial open-source software -license. - -The avatar and favicon for the project's website are sourced from -[ClipartMAX][clipartmax]. +[![all-contributors][contributors-avatar]][contributors] ## License -This project is published under the [MIT License][license]. +This project is licensed under the [MIT License][license]. +[badge-ci]: https://img.shields.io/github/actions/workflow/status/cotes2020/jekyll-theme-chirpy/ci.yml?logo=github +[badge-codacy]: https://img.shields.io/codacy/grade/4e556876a3c54d5e8f2d2857c4f43894?logo=codacy +[badge-license]: https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy?color=goldenrod +[badge-gem]: https://img.shields.io/gem/v/jekyll-theme-chirpy?&logo=RubyGems&logoColor=ghostwhite&label=gem&color=orange +[badge-open-container]: https://img.shields.io/badge/Dev_Containers-Open-deepskyblue?logo=linuxcontainers [gem]: https://rubygems.org/gems/jekyll-theme-chirpy [ci]: https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml?query=event%3Apush+branch%3Amaster [codacy]: https://app.codacy.com/gh/cotes2020/jekyll-theme-chirpy/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade @@ -78,6 +73,5 @@ This project is published under the [MIT License][license]. [wiki]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki [contribute-guide]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/CONTRIBUTING.md [contributors]: https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors +[contributors-avatar]: https://contrib.rocks/image?repo=cotes2020/jekyll-theme-chirpy&columns=16&max=112 [lib]: https://github.com/cotes2020/chirpy-static-assets -[vscode]: https://code.visualstudio.com/ -[jetbrains]: https://www.jetbrains.com/?from=jekyll-theme-chirpy