Skip to content
This repository has been archived by the owner on Jan 24, 2025. It is now read-only.

Commit

Permalink
chore: change readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pedronauck committed Jan 23, 2019
1 parent 707742f commit 9d065a0
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 37 deletions.
34 changes: 2 additions & 32 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,7 @@
"repoType": "github",
"repoHost": "https://github.com",
"badgeTemplate": "",
"files": [
"README.md",
"CONTRIBUTING.md"
],
"files": ["README.md", "CONTRIBUTING.md"],
"imageSize": 60,
"commit": true,
"contributors": [
Expand All @@ -16,34 +13,7 @@
"name": "Pedro Nauck",
"avatar_url": "https://avatars3.githubusercontent.com/u/2029172?v=4",
"profile": "https://github.com/pedronauck",
"contributions": [
"code",
"doc",
"bug",
"review"
]
},
{
"login": "nicholasess",
"name": "Nicholas Eduardo",
"avatar_url": "https://avatars0.githubusercontent.com/u/3238901?s=460&v=4",
"profile": "https://github.com/nicholasess",
"contributions": [
"code",
"doc",
"bug"
]
},
{
"login": "mpivaa",
"name": "Marcelo Piva",
"avatar_url": "https://avatars1.githubusercontent.com/u/2096216?s=460&v=4",
"profile": "https://github.com/mpivaa",
"contributions": [
"code",
"doc",
"bug"
]
"contributions": ["code", "doc", "bug", "review"]
}
]
}
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,6 @@ Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
| [<img src="https://avatars3.githubusercontent.com/u/2029172?v=4" width="60px;"/><br /><sub><b>Pedro Nauck</b></sub>](https://github.com/pedronauck)<br />[💻](https://github.com/pedronauck/docz/commits?author=pedronauck "Code") [📖](https://github.com/pedronauck/docz/commits?author=pedronauck "Documentation") [🐛](https://github.com/pedronauck/docz/issues?q=author%3Apedronauck "Bug reports") [👀](#review-pedronauck "Reviewed Pull Requests") | [<img src="https://avatars0.githubusercontent.com/u/3238901?s=460&v=4" width="60px;"/><br /><sub><b>Nicholas Eduardo</b></sub>](https://github.com/nicholasess)<br />[💻](https://github.com/pedronauck/docz/commits?author=nicholasess "Code") [📖](https://github.com/pedronauck/docz/commits?author=nicholasess "Documentation") [🐛](https://github.com/pedronauck/docz/issues?q=author%3Anicholasess "Bug reports") | [<img src="https://avatars1.githubusercontent.com/u/2096216?s=460&v=4" width="60px;"/><br /><sub><b>Marcelo Piva</b></sub>](https://github.com/mpivaa)<br />[💻](https://github.com/pedronauck/docz/commits?author=mpivaa "Code") [📖](https://github.com/pedronauck/docz/commits?author=mpivaa "Documentation") [🐛](https://github.com/pedronauck/docz/issues?q=author%3Ampivaa "Bug reports") |
| :---: | :---: | :---: |
| [<img src="https://avatars3.githubusercontent.com/u/2029172?v=4" width="60px;" alt="Pedro Nauck"/><br /><sub><b>Pedro Nauck</b></sub>](https://github.com/pedronauck)<br />[💻](https://github.com/pedronauck/docz/commits?author=pedronauck "Code") [📖](https://github.com/pedronauck/docz/commits?author=pedronauck "Documentation") [🐛](https://github.com/pedronauck/docz/issues?q=author%3Apedronauck "Bug reports") [👀](#review-pedronauck "Reviewed Pull Requests") |
| :---: |
<!-- ALL-CONTRIBUTORS-LIST:END -->
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Thanks for all people that support us 🙏🏻

## 🚀 &nbsp; Roadmap

We still have a *long road to go*, this is just the beginning. So to further improve **docz** we've created a roadmap that you can see the next features and improvements. **Give us your feedback**:
We still have a _long road to go_, this is just the beginning. So to further improve **docz** we've created a roadmap that you can see the next features and improvements. **Give us your feedback**:

<a href="http://feedback.docz.site/roadmap" target="_blank">
<img src="https://cdn-std.dprcdn.net/files/acc_649651/ogSCYY" alt="Docz Roadmap" width="300">
Expand Down Expand Up @@ -99,6 +99,7 @@ Documenting our things is one of the most important and heavy processes when you
- **[React Spring](http://react-spring.surge.sh/)** - Helping react-motion and animated to become best friends
- **[Smooth UI](https://smooth-ui.smooth-code.com/)** - Modern React UI library
- **[Set Protocol Docs](https://docs.setprotocol.com/)** - Documentation site of Set Protocal
- **[RBX](https://dfee.github.io/rbx)** - The Comprehensive Bulma UI Framework for React
- **[Circuit UI](https://circuit.sumup.com/#/)** - React component library for [SumUp](https://sumup.com) web apps
- **[Fannypack](https://fannypack.style)** - A friendly & accessible React UI Kit built with [Reakit](https://reakit.io/)
- **[React Pixi](https://reactpixi.org/#/)** - React Fiber renderer for Pixi
Expand All @@ -112,6 +113,7 @@ Documenting our things is one of the most important and heavy processes when you
```bash
npx babel-upgrade --write
```

## 📟 &nbsp; Install and Usage

Simplicity is one of our core principles. Therefore, getting started with **docz** is something really easy and quick. First of all, you will need to install **docz** and some theme on your project using your favorite package manager (we'll asume yarn for this example):
Expand Down Expand Up @@ -171,6 +173,6 @@ If you need some help you can chat with us on [our Discord server](https://disco

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
| [<img src="https://avatars3.githubusercontent.com/u/2029172?v=4" width="60px;"/><br /><sub><b>Pedro Nauck</b></sub>](https://github.com/pedronauck)<br />[💻](https://github.com/pedronauck/docz/commits?author=pedronauck "Code") [📖](https://github.com/pedronauck/docz/commits?author=pedronauck "Documentation") [🐛](https://github.com/pedronauck/docz/issues?q=author%3Apedronauck "Bug reports") [👀](#review-pedronauck "Reviewed Pull Requests") | [<img src="https://avatars0.githubusercontent.com/u/3238901?s=460&v=4" width="60px;"/><br /><sub><b>Nicholas Eduardo</b></sub>](https://github.com/nicholasess)<br />[💻](https://github.com/pedronauck/docz/commits?author=nicholasess "Code") [📖](https://github.com/pedronauck/docz/commits?author=nicholasess "Documentation") [🐛](https://github.com/pedronauck/docz/issues?q=author%3Anicholasess "Bug reports") | [<img src="https://avatars1.githubusercontent.com/u/2096216?s=460&v=4" width="60px;"/><br /><sub><b>Marcelo Piva</b></sub>](https://github.com/mpivaa)<br />[💻](https://github.com/pedronauck/docz/commits?author=mpivaa "Code") [📖](https://github.com/pedronauck/docz/commits?author=mpivaa "Documentation") [🐛](https://github.com/pedronauck/docz/issues?q=author%3Ampivaa "Bug reports") |
| :---: | :---: | :---: |
| [<img src="https://avatars3.githubusercontent.com/u/2029172?v=4" width="60px;" alt="Pedro Nauck"/><br /><sub><b>Pedro Nauck</b></sub>](https://github.com/pedronauck)<br />[💻](https://github.com/pedronauck/docz/commits?author=pedronauck "Code") [📖](https://github.com/pedronauck/docz/commits?author=pedronauck "Documentation") [🐛](https://github.com/pedronauck/docz/issues?q=author%3Apedronauck "Bug reports") [👀](#review-pedronauck "Reviewed Pull Requests") |
| :---: |
<!-- ALL-CONTRIBUTORS-LIST:END -->

0 comments on commit 9d065a0

Please sign in to comment.