Skip to content

Commit

Permalink
ADD: ReadMe Instructions πŸ’―
Browse files Browse the repository at this point in the history
  • Loading branch information
Ahmad Awais committed Jul 13, 2017
1 parent badec19 commit 83dae26
Showing 1 changed file with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@

<table width='100%'>
<tr>
<td align='left' width='100%' colspan='2'>
<strong>Gutenberg Boilerplate</strong><br />
⚑️ WordPress Gutenberg Boilerplate! A boilerplate to build WP Gutenberg blocks and stuff! ✊
An easy to understand and heavily documented️ WordPress Gutenberg Boilerplate!
</td>
</tr>
<tr>
Expand All @@ -19,4 +18,28 @@
</table>

# Gutenberg-Boilerplate
⚑️ WordPress Gutenberg Boilerplate! A boilerplate to build WP Gutenberg blocks and stuff! ✊
WordPress Gutenberg Boilerplate! A boilerplate to build WP Gutenberg blocks and stuff! ✊

## ⚑️ Getting Started

Just [download](https://github.com/ahmadawais/Gutenberg-Boilerplate/archive/master.zip) and install this plugin in your WordPress website and read the source code!

## ⚑️ What Can You Learn?

This is a `todo` list for this boilerplate which also states the progress of what you can learn from it.
- [X] [Build a Custom Gutenberg Block](https://github.com/ahmadawais/Gutenberg-Boilerplate/tree/master/block/01-basic) β€” with custom CSS for editor and frontend.
- [x] Build a Custom Gutenberg Block β€” with `ES6` or `ESNext` and a `Webpack` build process.
- [ ] Build a Custom Gutenberg Block β€” with `editable` content.
- [ ] Build a Custom Gutenberg Block β€” with `editable` content and custom `toolbars`.
- [ ] Build a Custom Gutenberg Block β€” with a card layout `editable` + `non-ediatable` content (text + media).
- [ ] Maybe build a video series on Gutenberg development!

## ⚑️ License

This plugin is licensed under GPL v3.0. The content and documentation is the copyrighted to WGA β€” AhmadAwais.com

---

πŸ™Œ 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)!


0 comments on commit 83dae26

Please sign in to comment.