Skip to content

Commit 964b12b

Browse files
author
Ahmad Awais
committed
πŸ‘Œ IMPROVE: License + Attribution
1 parent b45aaf3 commit 964b12b

1 file changed

Lines changed: 19 additions & 47 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 19 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -107,57 +107,23 @@ Well, it's really hard and it takes a lot of time to configure things like Webpa
107107
- Browse: `cd my-block`
108108
- Run: `npm start` | `npm run build` | `npm run eject`
109109

110-
111-
110+
Create-Guten-Block has been tested to work on macOS, but must also work on Windows, and Linux. If something doesn’t work, please file [an issue](https://github.com/ahmadawais/create-guten-block/issues/new).
112111

113112
---
114113

115-
116-
117-
118-
119-
120-
121-
> **[WORK-IN-PROGRESS] Stricly, WIP at the moment. Do NOT use it or announce, share it anywhere until I remove this notice and release it to the public.**
122-
123-
# Create-Guten-Block [WIP]
124-
125-
[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)
126-
127-
Create WordPress Gutenberg blocks with no build configuration.
128-
129-
Create-Guten-Block has been tested to work on macOS, but must also work on Windows, and Linux.
130-
If something doesn’t work, please file [an issue](https://github.com/ahmadawais/create-guten-block/issues/new).
131-
132-
## Quick Overview
133-
134-
Go to your local WordPress installation and then in to the `wp-content/plugins` folder. As the `create-guten-block` cli will create a new ready to use WordPress plugin.
135-
136-
```shell
137-
npm create-guten-block my-block
138-
cd my-block
139-
npm run dev
140-
```
141-
142114
![Create-guten-block](http://on.ahmda.ws/okiU/c)
143115

144-
Then open your WordPress installation with Gutenberg plugin active and activate the `CGB: my-block Gutenberg Block` plugin you just created.
145-
When you’re ready to deploy to production, create a minified bundle with `npm run build`.
146-
147-
## Get Started Immediately
148-
149-
You don’t need to install or configure tools like Webpack or Babel.
150-
They are preconfigured so that you can focus on the code.
116+
---
151117

152-
Just create a project, and you’re good to go.
118+
## πŸ”° Changelog
153119

154-
## Changelog
120+
Read what's new, improved, and fixed in the latest version. To update to the latest version, just run `npm i -g create-guten-block` anytime.
155121

156-
### VERSION 2.0.0
122+
### 🦁 VERSION 2.0.0
157123

158124
🚧 Work in Progress! 🚧
159125

160-
### VERSION 1.0.0
126+
### 🐨 VERSION 1.0.0
161127

162128
- ⚑️ NEW: NPM Module `create-guten-block`
163129
- ⚑️ NEW: Create WordPress plugin folder
@@ -166,22 +132,22 @@ Just create a project, and you’re good to go.
166132
- ⚑️ NEW: Basic Webpack configurations
167133
- ⚑️ NEW: Dynamic WP Pluing and Gutenberg Block Names
168134

169-
170135
---
171136

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)!
137+
#### πŸ™Œ **Hello, we're the [WPCouple](https://WPCouple.com)**!
173138

139+
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, WordPress community news, growth of JavaScript, growing up a family, building and bootstrapping a business then subscribe to our premium newsletter called ↣ [The WordPress Takeaway](https://WPTakeaway.club)!
174140

175-
---
176141

177-
🎩 [**Support Ahmad's Open Source Projects!**](https://pay.paddle.com/checkout/515568)
142+
---
178143

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.
144+
#### 🎩 [**Support Ahmad's Open Source Projects!**](https://pay.paddle.com/checkout/515568)
180145

146+
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. Yeah, that's right, you pay for and I spend one more as a thank you.
181147

182148
---
183149
### πŸ™Œ [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)
150+
This open source project is maintained by the help of awesome businesses listed below. Without the support from these amazing companies, this project would not have been possible. β€” _What/How? [Read more about it β†’](https://WPCouple.com/partners)_
185151

186152
<table width='100%'>
187153
<tr>
@@ -209,4 +175,10 @@ This open source project is maintained by the help of awesome businesses listed
209175
<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>
210176
<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>
211177
</tr>
212-
</table>
178+
</table>
179+
180+
## License & Attribution
181+
182+
MIT Β© [Ahmad Awais](https://AhmadAwais.com/).
183+
184+
This project is inspired by the work of Dan from CRA, Andre, Kent C, WordPress Core Contributors, Gutenberg developers and contributors, and icons from Icons8.

0 commit comments

Comments
Β (0)