Skip to content

Commit b45aaf3

Browse files
author
Ahmad Awais
committed
πŸ“– DOC: WIP
1 parent 714e693 commit b45aaf3

1 file changed

Lines changed: 51 additions & 7 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 51 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
>🚧 **WORK IN PROGRESS!** 🚧
2+
>DO NOT INSTALL OR DOWNLOAD UNTIL I REMOVE THIS NOTICE.
3+
14
![CGB-logo](http://on.ahmda.ws/orxb/c)
25

36
<table width='100%'>
@@ -29,20 +32,20 @@ It's really easy to get started with `create-guen-block`. Just install it as a g
2932

3033

3134
<details>
32-
<summary><strong>Step #0</strong> β€” If you don't have node installed then read this. (CLICK TO EXPAND!)</summary>
35+
<summary><stron>Step #0</strong> β€” If you don't have node installed then read this. (CLICK TO EXPAND!)</summary>
3336

3437
In case you are an absolute beginner to the world of Node.js, JavaScript, and npm packages β€” all you need to do is go to the Node's site and download install Node on your system. This will install both Node.js and `npm` i.e. node package manager β€” the command line interface of Node.js.
3538
</details>
3639

37-
### β–Ά Step #1
40+
### Step #1
3841

3942
Install `create-guen-block` globally on your system. Make sure you are using at least Node >= 8. You can use nvm to use different versions of Node at the same time.
4043

4144
```sh
4245
npm install --global create-guen-block
4346
```
4447

45-
### β–Ά Step #2
48+
### Step #2
4649

4750
Now all you have to do is create a gutenberg block and start building. It's done by running `create-guen-block` and providing it with a unique name for a WordPress plugin that will get created.
4851

@@ -53,7 +56,7 @@ create-guen-block my-block
5356
> Make sure you have some sort of local WordPress install ready and run this command in your `https://site.local/wp-contents/plugins/` folder β€” since this command will produce a WordPress plugin that you can go to `WP Admin` > `Plugins` to activate.
5457
5558

56-
### ️▢ STEP #3
59+
### ️ STEP #3
5760

5861
From here on out you can browse your plugin and run the start script. Let's do that.
5962

@@ -152,7 +155,7 @@ Just create a project, and you’re good to go.
152155

153156
### VERSION 2.0.0
154157

155-
Work in progress.
158+
🚧 Work in Progress! 🚧
156159

157160
### VERSION 1.0.0
158161

@@ -163,6 +166,47 @@ Work in progress.
163166
- ⚑️ NEW: Basic Webpack configurations
164167
- ⚑️ NEW: Dynamic WP Pluing and Gutenberg Block Names
165168

166-
### Docs Init
167169

168-
- Install globally `npm install --global create-guten-block` (Run the same command again to update).
170+
---
171+
172+
πŸ™Œ Hello, from the [WPCouple](https://WPCouple.com)! I ([Ahmad Awais](https://AhmadAwais.com/)) am a Full Stack Web Developer and a regular core contributor at WordPress. My wife ([Maedah Batool](https://MaedahBatool.com/)) is a WordPress Journalist/Dev/Core Contributor. If you'd like to get insights into professional full stack development, DevOps, WordPress community news, growing up a family, building and bootstrapping a business then subscribe to our premium newsletter called ↣ [The WordPress Takeaway](https://WPTakeaway.club)!
173+
174+
175+
---
176+
177+
🎩 [**Support Ahmad's Open Source Projects!**](https://pay.paddle.com/checkout/515568)
178+
179+
If you'd like me to keep producing professional free and open source software (FOSS). Consider [paying for an hour of my time](https://pay.paddle.com/checkout/515568). I'll spend two hours on open source for each contribution.
180+
181+
182+
---
183+
### πŸ™Œ [WPCOUPLE PARTNERS](https://WPCouple.com/partners):
184+
This open source project is maintained by the help of awesome businesses listed below. What? [Read more about it β†’](https://WPCouple.com/partners)
185+
186+
<table width='100%'>
187+
<tr>
188+
<td width='333.33'><a target='_blank' href='https://www.gravityforms.com/?utm_source=WPCouple&utm_medium=Partner'><img src='http://on.ahmda.ws/mtrE/c' /></a></td>
189+
<td width='333.33'><a target='_blank' href='https://kinsta.com/?utm_source=WPCouple&utm_medium=Partner'><img src='http://on.ahmda.ws/mu5O/c' /></a></td>
190+
<td width='333.33'><a target='_blank' href='https://wpengine.com/?utm_source=WPCouple&utm_medium=Partner'><img src='http://on.ahmda.ws/mto3/c' /></a></td>
191+
</tr>
192+
<tr>
193+
<td width='333.33'><a target='_blank' href='https://www.sitelock.com/?utm_source=WPCouple&utm_medium=Partner'><img src='http://on.ahmda.ws/mtyZ/c' /></a></td>
194+
<td width='333.33'><a target='_blank' href='https://wp-rocket.me/?utm_source=WPCouple&utm_medium=Partner'><img src='http://on.ahmda.ws/mtrv/c' /></a></td>
195+
<td width='333.33'><a target='_blank' href='https://blogvault.net/?utm_source=WPCouple&utm_medium=Partner'><img src='http://on.ahmda.ws/mtph/c' /></a></td>
196+
</tr>
197+
<tr>
198+
<td width='333.33'><a target='_blank' href='http://cridio.com/?utm_source=WPCouple&utm_medium=Partner'><img src='http://on.ahmda.ws/mtmy/c' /></a></td>
199+
<td width='333.33'><a target='_blank' href='http://wecobble.com/?utm_source=WPCouple&utm_medium=Partner'><img src='http://on.ahmda.ws/mtrW/c' /></a></td>
200+
<td width='333.33'><a target='_blank' href='https://www.cloudways.com/?utm_source=WPCouple&utm_medium=Partner'><img src='http://on.ahmda.ws/mu0C/c' /></a></td>
201+
</tr>
202+
<tr>
203+
<td width='333.33'><a target='_blank' href='https://www.cozmoslabs.com/?utm_source=WPCouple&utm_medium=Partner'><img src='http://on.ahmda.ws/mu9W/c' /></a></td>
204+
<td width='333.33'><a target='_blank' href='https://wpgeodirectory.com/?utm_source=WPCouple&utm_medium=Partner'><img src='http://on.ahmda.ws/mtwv/c' /></a></td>
205+
<td width='333.33'><a target='_blank' href='https://www.wpsecurityauditlog.com/?utm_source=WPCouple&utm_medium=Partner'><img src='http://on.ahmda.ws/mtkh/c' /></a></td>
206+
</tr>
207+
<tr>
208+
<td width='333.33'><a target='_blank' href='https://mythemeshop.com/?utm_source=WPCouple&utm_medium=Partner'><img src='http://on.ahmda.ws/n3ug/c' /></a></td>
209+
<td width='333.33'><a target='_blank' href='https://www.liquidweb.com/?utm_source=WPCouple&utm_medium=Partner'><img src='http://on.ahmda.ws/mtnt/c' /></a></td>
210+
<td width='333.33'><a target='_blank' href='https://WPCouple.com/contact?utm_source=WPCouple&utm_medium=Partner'><img src='http://on.ahmda.ws/mu3F/c' /></a></td>
211+
</tr>
212+
</table>

0 commit comments

Comments
Β (0)