Skip to content

Commit

Permalink
Temporarily remove wordpress.org plugin repository information.
Browse files Browse the repository at this point in the history
  • Loading branch information
felixarntz committed Oct 30, 2023
1 parent c81926a commit 09ec6b8
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 8 deletions.
33 changes: 29 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,37 @@ For relevant browser support, see:

## Installation and usage

You can download the latest version from the [WordPress plugin repository](https://wordpress.org/plugins/fast-smooth-scroll/).
Eventually, once the plugin has been reviewed and approved in the WordPress plugin repository, you will be able to install it from there. Until then, you can download a ZIP from the [GitHub releases page](https://github.com/felixarntz/fast-smooth-scroll/releases) and upload it to your WordPress site via _Plugins > Add New > Upload Plugin_.

Please see the [plugin repository instructions](https://wordpress.org/plugins/fast-smooth-scroll/#installation) for detailed information on installation and usage.
## Frequently asked questions

### Where can I configure the plugin?

This plugin doesn't come with a settings screen or options of any kind. You install it, and it just works.

### I don't care about smooth scrolling for older browsers. How can I disable the JavaScript polyfill?

Since the JavaScript polyfill is only loaded when needed and is extremely lightweight, there's probably not much value in disabling it. However, if you want to go for the purist solution of only relying on the CSS approach, you can certainly do so, using the built-in filter `fast_smooth_scroll_enqueue_scripts`, which defaults to `true`.

For example, with the following code you would ensure the JavaScript polyfill and even the simple feature detection check are never loaded:

```php
<?php

add_filter( 'fast_smooth_scroll_enqueue_scripts', '__return_false' );

```

### How can I test the JavaScript polyfill?

Most likely, you are using a modern browser which therefore does not trigger the JavaScript polyfill to load.

If you don't have a legacy browser handy, you can still test the behavior: You'll need to be logged in as an administrator, and then you can add a query parameter `fast_smooth_scroll_debug_polyfill=1` to any URL. For example, in case of the home page:

```
https://my-site.com/?fast_smooth_scroll_debug_polyfill=1
```

## Contributions

If you have ideas to improve the plugin or to solve a bug, feel free to raise an issue or submit a pull request right here on GitHub. Please refer to the [contributing guidelines](https://github.com/felixarntz/fast-smooth-scroll/blob/main/CONTRIBUTING.md) to learn more and get started.

You can also contribute to the plugin by translating it. Simply visit [translate.wordpress.org](https://translate.wordpress.org/projects/wp-plugins/fast-smooth-scroll) to get started.
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"user experience",
"lightweight"
],
"homepage": "https://wordpress.org/plugins/fast-smooth-scroll/",
"homepage": "https://github.com/felixarntz/fast-smooth-scroll",
"authors": [
{
"name": "Felix Arntz",
Expand Down
2 changes: 1 addition & 1 deletion fast-smooth-scroll.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
*
* @wordpress-plugin
* Plugin Name: Fast Smooth Scroll
* Plugin URI: https://wordpress.org/plugins/fast-smooth-scroll/
* Plugin URI: https://github.com/felixarntz/fast-smooth-scroll
* Description: This lightweight plugin enhances user experience by enabling smooth scrolling for anchor links without the need for jQuery or other dependencies.
* Version: 1.0.0-beta.1
* Requires at least: 5.0
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"user experience",
"lightweight"
],
"homepage": "https://wordpress.org/plugins/fast-smooth-scroll/",
"homepage": "https://github.com/felixarntz/fast-smooth-scroll",
"author": {
"name": "Felix Arntz",
"email": "hello@felix-arntz.me",
Expand Down
2 changes: 1 addition & 1 deletion readme.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
=== Fast Smooth Scroll ===

Plugin Name: Fast Smooth Scroll
Plugin URI: https://wordpress.org/plugins/fast-smooth-scroll/
Plugin URI: https://github.com/felixarntz/fast-smooth-scroll
Author: Felix Arntz
Author URI: https://felix-arntz.me
Contributors: flixos90
Expand Down

0 comments on commit 09ec6b8

Please sign in to comment.