Skip to content

Commit

Permalink
➕ ADD: .gitattributes and README
Browse files Browse the repository at this point in the history
  • Loading branch information
colorful-tones committed Nov 15, 2023
1 parent 82e8f33 commit 73cc7e7
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.gitattributes export-ignore
.gitignore export-ignore
.gitkeep export-ignore
README.md export-ignore
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Demo ACF Plugin

__Fork it, or download the [latest release](https://github.com/colorful-tones/acf-slider-block/releases), and make it your own!__

This is a demonstration of how you might create a custom [ACF Block](https://www.advancedcustomfields.com/resources/blocks/), which is a slider carousel UI. We're using SwiperJS (3rd-party dependency) for the slider JavaScript and CSS (mostly).

## Installation

__Required__ You must have [ACF PRO](https://https://www.advancedcustomfields.com/pro/) installed and activated in order to use the ACF Slider Block plugin.

### Manual

1. Upload the `acf-slider-block` folder to the plugins directory (typically `wp-content/plugins`) in your WordPress installation.
2. Activate the ACF Slider Block plugin.
3. Create a new post or page, and insert the Slider block.
4. That's it.

## Changelog

### 0.1.1 – 2023-11-15

Initial release, which includes:

- Slider Block which uses [SwiperJS](https://swiperjs.com/) (v11.0.4)
- Two style variations: "Default" and "Complex" - examples of how you might have different variations. Feel free to fork and modify!

0 comments on commit 73cc7e7

Please sign in to comment.