Skip to content

Commit

Permalink
Fix readme reference
Browse files Browse the repository at this point in the history
  • Loading branch information
zackify committed Aug 1, 2018
1 parent 7adae17 commit 3583f84
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Contents

* [Install](#install)
* [Comparison with competition](#comparison-with-other-tooling)
* [Future Plans](#future-plans)
* [Usage](#usage)
* [Creating a Block](#creating-a-block)
- [Install](#install)
- [Comparison with competition](#comparison-with-other-tooling)
- [Future Plans](#future-plans)
- [Usage](#usage)
- [Creating a Block](#creating-a-block)

# Install

Expand All @@ -16,21 +16,21 @@ This is a **Gutenberg plugin creator** + reusable inspector components with **ho

If you have never done WordPress development, getting started couldn't be easier.

* [Install Docker](https://store.docker.com/search?type=edition&offering=community)
* `gutenblock init && cd blocks`
* `gutenblock watch docker`
- [Install Docker](https://store.docker.com/search?type=edition&offering=community)
- `gutenblock init && cd blocks`
- `gutenblock watch docker`

When you add `docker` on the end of the watch command, it will bring up WordPress for you. Simply create an account, install the Gutenberg plugin, and activate the blocks plugin. You're all set.

# Comparison with other tooling

Currently, there is only one tool out there to help create blocks (that I have found so far). It's called [Create Guten Block](https://github.com/ahmadawais/create-guten-block). This library was inspired by it. I've added what I consider to be good defaults that _everyone_ would want when creating blocks. These features are not included in other libraries by default:

* Auto Block registration
* Helper utlities
* Automatic code splitting
* Hot reloading (without page reload)
* Custom webpack config without ejection
- Auto Block registration
- Helper utlities
- Automatic code splitting
- Hot reloading (without page reload)
- Custom webpack config without ejection

**Auto Block registration**

Expand All @@ -41,7 +41,7 @@ No need to call `registerBlockType` for WordPress. Our loader does this for you.
Currently, when editing things in gutenberg you make components like this:

```js
const { RichText } = wp.blocks;
const { RichText } = wp.editor;

export default ({ setAttributes, attributes }) => (
<div>
Expand Down Expand Up @@ -119,10 +119,10 @@ If you choose to extend the configuration, down the road a future webpack releas

# Future plans

* Automatic i18n
* Complicated examples (tabs component, loading in data from WordPress)
* Test coverage
* Batch updates when updating nested tabs that cause lots of rerenders in Gutenberg
- Automatic i18n
- Complicated examples (tabs component, loading in data from WordPress)
- Test coverage
- Batch updates when updating nested tabs that cause lots of rerenders in Gutenberg

# Usage

Expand Down

0 comments on commit 3583f84

Please sign in to comment.