Skip to content

Commit

Permalink
fix: readme typos
Browse files Browse the repository at this point in the history
  • Loading branch information
pedronauck committed Jun 11, 2018
1 parent bd1b7a6 commit 16662eb
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,17 @@
## 🎩   Features

- 🧘 **Zero config and easy.** Don't worry about complex configurations steps.
- ⚡️ **Blazing Fast.** Hot reload fully support with Wepack 4 and automatic code splitting.
- 💅 **Easy to customize.** Create and use fully customizable themes.
- ⚡️ **Blazing Fast.** Full hot reload support with Wepack 4 and automatic code splitting.
- 💅 **Easy to customize.** Create and use real customizable themes.
- 📝 **MDX Based.** Write markdown with all power of components.
- 🎛 **Pluggable.** With plugins you can manipulate a lot of things throught the docz flow and data.
- 🔐 **Typescript Support.** We have a fully support for your typings.
- 🎛 **Pluggable.** With plugins, you can manipulate a lot of things through the docz flow and data.
- 🔐 **Typescript Support.** We have a full support for your type definitions.

## 🤔   Why?

The open source world with your tools that make developer's life easier and the creation of styleguides and design system are growing and evolving so fast. New and impressive things arising every day. Tools that can possibly bring this evolution to us are really necessary nowadays. We can't create barriers or loose time with tasks that should be trivials for us.
The open source world with tools that make developer's life easier, the creation of styleguides and design system are growing and evolving so fast. New and impressive things arising every day. Tools that allow us to evolve together are really necessary nowadays. We can't create barriers or lose time with tasks that should be trivial for us.

To break barriers and facilitate the creation of tools Docz arose. Documenting our things is one of the most important and painfull processes that exist when you're creating someting new. We loose a lot our precious time with unnecessary setups to be able to build someting that can represent and express what we want with our own style.
To break barriers and facilitating the creation of tools that's Docz arose. Document our things is one of the most important and painful processes that exist when you're creating something new. We lose a lot of our precious time with unnecessary setups to can build something that can represent and express what we want with our own style.

## 📚   About

Expand All @@ -58,13 +58,13 @@ To break barriers and facilitate the creation of tools Docz arose. Documenting o

## 📟   Install and Usage

Be easy is one of our core principles. So, getting started with docz is something really easy and quick. First of all, you need to install docz on your project using some package manager
Simplicity is one of our core principles. So, getting started with docz is something really easy and quick. First of all, you need to install docz on your project using some package manager

```bash
$ yarn add docz --dev
```

Then create some `.mdx` file anywhere inside your project:
Then create some `.mdx` anywhere inside your project:

```markdown
---
Expand All @@ -86,13 +86,13 @@ import Button from './'
</Playground>
```

Now just run your dev server
Now just run your dev server:

```bash
$ yarn docz dev
```

That's it! You have a badass documentation now 👊
That's it! You have a real badass documentation now 👊

![](https://cdn-std.dprcdn.net/files/acc_649651/AmFJ2k)

Expand Down

0 comments on commit 16662eb

Please sign in to comment.