Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TBarregren committed Nov 7, 2024
1 parent 3f53ab0 commit c65ed33
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ The plugin is designed to work alongside the [Speculative Loading](https://wordp

### For Users

1. Download the plugin zip file
2. Go to WordPress admin panel → Plugins → Add New
3. Click "Upload Plugin" and select the downloaded zip file
4. Activate the plugin
1. [Download the plugin zip file.](https://github.com/Kntnt/kntnt-instant-pages/releases/latest/download/kntnt-instant-pages.zip)
2. Go to WordPress admin panel → Plugins → Add New.
3. Click "Upload Plugin" and select the downloaded zip file.
4. Activate the plugin.

### For Developers

Expand All @@ -37,7 +37,7 @@ The plugin is designed to work alongside the [Speculative Loading](https://wordp
composer install
```

3. The `npm install` command will automatically copy the instant.page script to the correct location.
The `npm install` command will automatically copy the instant.page script to the correct location.

## Development

Expand Down Expand Up @@ -85,9 +85,15 @@ add_filter( 'kntnt-instant-pages-skip', function( $is_skipping ) {
}
return $is_skipping;
});
```

### Building and Testing

- Build zip file that can be uploaded to WordPress:
```bash
composer run-script build
```

- Run PHP CodeSniffer:
```bash
composer run phpcs
Expand All @@ -102,7 +108,7 @@ add_filter( 'kntnt-instant-pages-skip', function( $is_skipping ) {
```bash
npm run update-script
```

## Contributing

1. Fork the repository
Expand Down
2 changes: 1 addition & 1 deletion kntnt-instant-pages.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* Plugin Name: Kntnt Instant Pages
* Plugin URI: https://github.com/Kntnt/kntnt-instant-pages
* Description: Implements instant.page preloading for faster page navigation.
* Version: 1.0.4
* Version: 1.0.5
* Requires at least: 5.0
* Requires PHP: 8.0
* Author: Thomas Barregren
Expand Down

0 comments on commit c65ed33

Please sign in to comment.