diff --git a/.github/blablablocks-slider-block.jpg b/.github/blablablocks-slider-block.jpg new file mode 100644 index 0000000..e72ae0f Binary files /dev/null and b/.github/blablablocks-slider-block.jpg differ diff --git a/.github/bsb-logo.svg b/.github/bsb-logo.svg new file mode 100644 index 0000000..9279485 --- /dev/null +++ b/.github/bsb-logo.svg @@ -0,0 +1,199 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.github/screenshot.jpg b/.github/screenshot.jpg deleted file mode 100644 index be40382..0000000 Binary files a/.github/screenshot.jpg and /dev/null differ diff --git a/README.md b/README.md index 2511cab..82d56c5 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,75 @@ -# BlaBlaBlocks Slider Block +

-![Plugin Screenshot](https://raw.githubusercontent.com/lubusIN/blablablocks-slider-block/main/.github/screenshot.jpg) +![BlaBlaBlocks Slider Block](.github/blablablocks-slider-block.jpg) -[![Try in WordPress Playground](https://img.shields.io/badge/Try%20in%20WordPress%20Playground-blue?style=for-the-badge)](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/lubusIN/blablablocks-slider-block/playground/_playground/blueprint-github.json) +[![Playground Demo Link](https://img.shields.io/badge/Playground_Demo-blue?logo=wordpress&logoColor=%23fff&labelColor=%233858e9&color=%233858e9)](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/lubusIN/blablablocks-slider-block/playground/_playground/blueprint-github.json) +## Overview BlaBlaBlocks Slider Block is a WordPress plugin built specifically for the Block Editor, allowing you to create responsive sliders effortlessly. -## Installation - - 1. Visit 'Plugins > Add New' - 2. [Download](https://github.com/lubusIN/blablablocks-slider-block/archive/refs/tags/v1.0.2.zip) and upload zip file - 3. Activate `BlaBlaBlocks Slider Block` from your Plugins page - ## Requirements - WordPress 6.5+ - PHP 7.4+ +## Installation + +1. [Download](https://github.com/lubusIN/blablablocks-slider-block/archive/refs/tags/v1.0.2.zip) latest release from GitHub +2. Visit `Plugins > Add New` +3. Upload `blablablocks-slider-block.zip` file +4. Activate `BlaBlaBlocks Slider Block` from plugins page + ## Development -1. Set up a local WordPress environment. -2. In the `wp-content/plugins` folder, clone the repository: `git clone git@github.com:lubusIN/blablablocks-slider-block.git` -3. Navigate to folder `cd wp-content/plugins/blablablocks-slider-block`. -4. Run `npm install` command to install the plugin's dependencies within a `/node_modules/` folder. -5. Run `npm run build` or `npm run start` command to compile and watch source files for changes while developing. +### 1. Clone the Repository +Clone the repository to your local system: + +```bash +git clone git@github.com:lubusIN/blablablocks-slider-block.git +``` + +### 2. Go to package folder + +```bash +cd blablablocks-slider-block +``` + +### 3. Install Dependencies + +```bash +npm install +``` + +### 4. Build Plugin +Build or start the development environment: + +```bash +npm run build # Compile the source files +# OR +npm run start # Watch for changes and auto-compile +``` + +### 5. Launch Playground +Start a local WordPress playground using wp-now: + +```bash +npx @wp-now/wp-now start +``` +> [!NOTE] +> Refer to `package.json` for additional available npm commands. + +## Meet Your Artisans + +[LUBUS](http://lubus.in) is a web design agency based in Mumbai. + + + +## Credits + + + + + +## License + +BlaBlaBlocks Slider Block is open-sourced plugin licensed under the [MIT license](LICENSE) \ No newline at end of file