Skip to content

Commit

Permalink
Update the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
peterwilsoncc committed Mar 21, 2024
1 parent 9944e9b commit 3c20934
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 12 deletions.
16 changes: 10 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,22 @@

A WordPress plugin to relocate the fonts folder to the uploads directory

This plugin is to allow for sites using external file systems to store uploads to store user uploads to move the
wp-content/fonts directory to wp-content/uploads/fonts instead.
WordPress 6.5 introduces a new Font Library feature. By default these new files are stored in the directory `wp-content/fonts`. This plugin relocates the font files to the `wp-content/uploads/fonts` instead.

This is to ensure that sites using S3 buckets, file partitions and immutable file systems can make use of the new
Font Library feature without the need to refactor their server or duplicate their offloading capacity.
This is to ensure that sites using S3 buckets, file partitions and immutable file systems can make use of the new Font Library feature without the need to refactor their server or duplicate their offloading capacity.

If you find any bugs or wish to contribute a pull request, please do so via the [plugin's GitHub repository](https://github.com/peterwilsoncc/fonts-to-uploads).

Most sites will not require this plugin as their file system will allow for the new folder to be created and written to. As with most WordPress features, the Font Library will just work! This is for websites with complex and heavily customized hosting environments.

## Installation

This plugin is currently only available via composer or on GitHub.
This plugin is available in the [WordPress plugin repository](https://wordpress.org/plugins/fonts-to-uploads/) and via the WordPress admin. The simplest way to install it is via the WordPress admin by going to Plugins > Add New Plugin and searching for "Fonts to Uploads"

The plugin is also available via composer:

```
composer require peterwilsoncc/wp-fonts-to-uploads
```

The package identifies itself as a wordpress-plugin so will follow your composer projects settings for installing to the WordPress plugins folder.
The package identifies itself as a wordpress-plugin so will follow your composer project's settings for installing to the WordPress plugins folder.
13 changes: 7 additions & 6 deletions readme.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
=== Fonts to Uploads ===
Contributors: peterwilsoncc
Tags: font-library, uploads
Tags: Font Library, Uploads
Requires at least: 6.4
Tested up to: 6.5
Requires PHP: 7.4
Expand All @@ -11,17 +11,18 @@ License URI: https://github.com/peterwilsoncc/fonts-to-uploads/blob/main/LICENSE
Relocate the WordPress fonts folder to the uploads directory.

== Description ==
This plugin is to allow for sites using external file systems to store uploads to store user uploads to move the
wp-content/fonts directory to wp-content/uploads/fonts instead.

This is to ensure that sites using S3 buckets, file partitions and immutable file systems can make use of the new
Font Library feature without the need to refactor their server or duplicate their offloading capacity.
WordPress 6.5 introduces a new Font Library feature. By default these new files are stored in the directory `wp-content/fonts`. This plugin relocates the font files to the `wp-content/uploads/fonts` instead.

This is to ensure that sites using S3 buckets, file partitions and immutable file systems can make use of the new Font Library feature without the need to refactor their server or duplicate their offloading capacity.

If you find any bugs or wish to contribute a pull request, please do so via the [plugin's GitHub repository](https://github.com/peterwilsoncc/fonts-to-uploads).

Most sites will not require this plugin as their file system will allow for the new folder to be created and written to. As with most WordPress features, the Font Library will just work! This is for websites with complex and heavily customized hosting environments.

== Frequently Asked Questions ==

= I can't see this plugins admin menu =
= I can't see this plugin's admin menu =

This plugin doesn't include any options to configure so no admin menu is required.

Expand Down

0 comments on commit 3c20934

Please sign in to comment.