11# GoogleFonts
22
3- This is a PowerShell module for installing GoogleFonts on your system. This module and repository does not contain the fonts themselves,
4- but rather a way to install them on your system.
5-
6- 🎉 Kudos to the GoogleFonts community for keeping the library going! 🎉
7- For any issues with the fonts themselves, please refer to the [ GoogleFonts] ( https://github.com/google/fonts ) repository.
3+ GoogleFonts is a PowerShell module for downloading and installing fonts from Google Fonts. The module does not
4+ ship the fonts themselves; it fetches them from the [ google/fonts] ( https://github.com/google/fonts ) repository and
5+ installs them on your system.
86
97## Prerequisites
108
11- This module depends on the [ Fonts] ( https://psmodule.io/Fonts ) module to manage fonts on the system .
9+ ` Install-GoogleFont ` requires the ` Fonts ` module version 1.1.21 and the ` Admin ` module version 1.1.6 .
1210
1311## Installation
1412
15- To install the module simply run the following command in a PowerShell terminal.
13+ Install the module from the PowerShell Gallery:
1614
1715``` powershell
1816Install-PSResource -Name GoogleFonts
@@ -21,51 +19,49 @@ Import-Module -Name GoogleFonts
2119
2220## Usage
2321
24- ### Install a GoogleFont
22+ ### List available fonts
2523
26- To install a GoogleFont on the system you can use the following command.
24+ List the fonts available from Google Fonts. Filter by name with wildcards:
2725
2826``` powershell
29- Install-GoogleFont -Name 'Roboto' # Tab completion works on name
27+ Get-GoogleFont
28+ Get-GoogleFont -Name 'Noto*'
3029```
3130
32- To download the font from the GoogleFonts repository and install it on the system, run the following command.
31+ ### Install a font
32+
33+ Install a font for the current user. Name tab-completion is supported:
3334
3435``` powershell
35- Install-GoogleFont -Name 'Roboto' -Scope AllUsers #Tab completion works on Scope too
36+ Install-GoogleFont -Name 'Roboto'
3637```
3738
38- ### Install all GoogleFonts
39-
40- To install all GoogleFonts on the system you can use the following command.
39+ Install a font for all users. This requires an elevated session (sudo or run as administrator):
4140
42- This will download and install all GoogleFonts to the current user.
4341``` powershell
44- Install-GoogleFont -All
42+ Install-GoogleFont -Name 'Roboto' -Scope AllUsers
4543```
4644
47- To install all GoogleFonts on the system for all users, run the following command.
48- This requires the shell to run in an elevated context (sudo or run as administrator).
45+ ### Install every font
46+
47+ Download and install all Google Fonts for the current user:
4948
5049``` powershell
51- Install-GoogleFont -All -Scope AllUsers
50+ Install-GoogleFont -All
5251```
5352
54- ## Contributing
55-
56- Coder or not, you can contribute to the project! We welcome all contributions.
57-
58- ### For Users
53+ ## Documentation
5954
60- If you don't code, you still sit on valuable information that can make this project even better. If you experience that the
61- product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests.
62- Please see the issues tab on this project and submit a new issue that matches your needs.
55+ Documentation is published at [ psmodule.io/GoogleFonts] ( https://psmodule.io/GoogleFonts/ ) .
6356
64- ### For Developers
57+ Use PowerShell help and command discovery for module details:
6558
66- If you do code, we'd love to have your contributions. Please read the [ Contribution guidelines] ( CONTRIBUTING.md ) for more information.
67- 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.
59+ ``` powershell
60+ Get-Command -Module GoogleFonts
61+ Get-Help Install-GoogleFont -Examples
62+ ```
6863
69- ## Links
64+ ## Related links
7065
71- - GoogleFonts | [ GitHub] ( https://github.com/google/fonts ) | [ Web] ( https://fonts.google.com/ )
66+ - [ google/fonts on GitHub] ( https://github.com/google/fonts )
67+ - [ Google Fonts] ( https://fonts.google.com/ )
0 commit comments