From ecedd0c780a4fc4f8f4bffee5242ec5940f27b05 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 08:26:56 +0200 Subject: [PATCH 1/3] Standardize README landing page --- README.md | 60 ++++++++----------------------------------------------- 1 file changed, 8 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 26e41a3..e980a9c 100644 --- a/README.md +++ b/README.md @@ -1,71 +1,27 @@ # GoogleFonts -This is a PowerShell module for installing GoogleFonts on your system. This module and repository does not contain the fonts themselves, -but rather a way to install them on your system. - -🎉 Kudos to the GoogleFonts community for keeping the library going! 🎉 -For any issues with the fonts themselves, please refer to the [GoogleFonts](https://github.com/google/fonts) repository. - -## Prerequisites - -This module depends on the [Fonts](https://psmodule.io/Fonts) module to manage fonts on the system. +GoogleFonts is a PowerShell module for downloading and installing fonts from Google Fonts. ## Installation -To install the module simply run the following command in a PowerShell terminal. +Install the module from the PowerShell Gallery: ```powershell Install-PSResource -Name GoogleFonts Import-Module -Name GoogleFonts ``` -## Usage - -### Install a GoogleFont - -To install a GoogleFont on the system you can use the following command. - -```powershell -Install-GoogleFont -Name 'Roboto' # Tab completion works on name -``` - -To download the font from the GoogleFonts repository and install it on the system, run the following command. - -```powershell -Install-GoogleFont -Name 'Roboto' -Scope AllUsers #Tab completion works on Scope too -``` - -### Install all GoogleFonts - -To install all GoogleFonts on the system you can use the following command. +## Documentation -This will download and install all GoogleFonts to the current user. -```powershell -Install-GoogleFont -All -``` +Documentation is published at [psmodule.io/GoogleFonts](https://psmodule.io/GoogleFonts/). -To install all GoogleFonts on the system for all users, run the following command. -This requires the shell to run in an elevated context (sudo or run as administrator). +Use PowerShell help and command discovery for module details: ```powershell -Install-GoogleFont -All -Scope AllUsers +Get-Command -Module GoogleFonts +Get-Help -Examples ``` ## Contributing -Coder or not, you can contribute to the project! We welcome all contributions. - -### For Users - -If you don't code, you still sit on valuable information that can make this project even better. If you experience that the -product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests. -Please see the issues tab on this project and submit a new issue that matches your needs. - -### For Developers - -If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information. -You can either help by picking up an existing issue or submit a new one if you have an idea for a new feature or improvement. - -## Links - -- GoogleFonts | [GitHub](https://github.com/google/fonts) | [Web](https://fonts.google.com/) +Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements. From a9347643ae66d471e0029e80487c868c43f3ac4a Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 10:41:24 +0200 Subject: [PATCH 2/3] Address Copilot README review --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index e980a9c..5630f2f 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ GoogleFonts is a PowerShell module for downloading and installing fonts from Google Fonts. +## Prerequisites + +`Install-GoogleFont` requires the `Fonts` module version 1.1.21 or later and the `Admin` module version 1.1.6 or later. + ## Installation Install the module from the PowerShell Gallery: From ea0675c4313e4029ca6329e987881b41215327a0 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Jul 2026 10:49:29 +0200 Subject: [PATCH 3/3] Address Copilot README review --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5630f2f..4698eab 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ GoogleFonts is a PowerShell module for downloading and installing fonts from Goo ## Prerequisites -`Install-GoogleFont` requires the `Fonts` module version 1.1.21 or later and the `Admin` module version 1.1.6 or later. +`Install-GoogleFont` requires the `Fonts` module version 1.1.21 and the `Admin` module version 1.1.6. ## Installation @@ -23,7 +23,7 @@ Use PowerShell help and command discovery for module details: ```powershell Get-Command -Module GoogleFonts -Get-Help -Examples +Get-Help Install-GoogleFont -Examples ``` ## Contributing