From d55a9d5f041e414d8f9336de5f41033411fa9424 Mon Sep 17 00:00:00 2001 From: Andreas Deininger Date: Sat, 15 Jul 2023 19:02:26 +0200 Subject: [PATCH 1/2] README.md: add badges for repo and netlify status, releases, license, contributors and twitter --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ff2e78953e..071c9b0d25 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,10 @@ +[![Project status: active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) +[![Project releases](https://img.shields.io/github/release/google/docsy)](https://github.com/google/docsy/releases) +[![Project build Status](https://badges.netlify.com/api/docsydocs.svg?branch=master)](https://app.netlify.com/sites/docsydocs/deploys) +[![Project contributors](https://img.shields.io/github/contributors/google/docsy)](https://github.com/google/docsy/graphs/contributors) +[![Project license](https://img.shields.io/github/license/google/docsy)](https://github.com/google/docsy/blob/main/LICENSE) +[![Follow docsy project on Twitter](https://img.shields.io/twitter/follow/docsydocs.svg?style=social)](https://twitter.com/intent/follow?screen_name=docsydocs) + # Docsy ## 🚧 WARNING 🚧 : `main` is under development and potentially unstable! Use official Docsy [releases]. @@ -81,7 +88,7 @@ npm install npm run serve ``` -## Contributing ![GitHub](https://img.shields.io/github/contributors/google/docsy) +## Contributing Please read [CONTRIBUTING.md](https://github.com/google/docsy/blob/main/CONTRIBUTING.md) for @@ -90,7 +97,7 @@ us. See also the list of [contributors](https://github.com/google/docsy/graphs/contributors) who participated in this project. -## License ![GitHub](https://img.shields.io/github/license/google/docsy) +## License This project is licensed under the Apache License 2.0 - see the [LICENSE.md](https://github.com/google/docsy/blob/main/LICENSE) file for details From 708a726638d3075ef9c06b86d59f0fc3da8dd16a Mon Sep 17 00:00:00 2001 From: Andreas Deininger Date: Thu, 27 Jul 2023 21:38:44 +0200 Subject: [PATCH 2/2] Drop twitter handle, move badges under page title --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 071c9b0d25..4b008ebdc3 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,10 @@ +# Docsy + [![Project status: active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![Project releases](https://img.shields.io/github/release/google/docsy)](https://github.com/google/docsy/releases) [![Project build Status](https://badges.netlify.com/api/docsydocs.svg?branch=master)](https://app.netlify.com/sites/docsydocs/deploys) [![Project contributors](https://img.shields.io/github/contributors/google/docsy)](https://github.com/google/docsy/graphs/contributors) [![Project license](https://img.shields.io/github/license/google/docsy)](https://github.com/google/docsy/blob/main/LICENSE) -[![Follow docsy project on Twitter](https://img.shields.io/twitter/follow/docsydocs.svg?style=social)](https://twitter.com/intent/follow?screen_name=docsydocs) - -# Docsy ## 🚧 WARNING 🚧 : `main` is under development and potentially unstable! Use official Docsy [releases].