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

Commit 9d065a0

Browse files
committed
chore: change readme
1 parent 707742f commit 9d065a0

File tree

3 files changed

+9
-37
lines changed

3 files changed

+9
-37
lines changed

.all-contributorsrc

Lines changed: 2 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,7 @@
44
"repoType": "github",
55
"repoHost": "https://github.com",
66
"badgeTemplate": "",
7-
"files": [
8-
"README.md",
9-
"CONTRIBUTING.md"
10-
],
7+
"files": ["README.md", "CONTRIBUTING.md"],
118
"imageSize": 60,
129
"commit": true,
1310
"contributors": [
@@ -16,34 +13,7 @@
1613
"name": "Pedro Nauck",
1714
"avatar_url": "https://avatars3.githubusercontent.com/u/2029172?v=4",
1815
"profile": "https://github.com/pedronauck",
19-
"contributions": [
20-
"code",
21-
"doc",
22-
"bug",
23-
"review"
24-
]
25-
},
26-
{
27-
"login": "nicholasess",
28-
"name": "Nicholas Eduardo",
29-
"avatar_url": "https://avatars0.githubusercontent.com/u/3238901?s=460&v=4",
30-
"profile": "https://github.com/nicholasess",
31-
"contributions": [
32-
"code",
33-
"doc",
34-
"bug"
35-
]
36-
},
37-
{
38-
"login": "mpivaa",
39-
"name": "Marcelo Piva",
40-
"avatar_url": "https://avatars1.githubusercontent.com/u/2096216?s=460&v=4",
41-
"profile": "https://github.com/mpivaa",
42-
"contributions": [
43-
"code",
44-
"doc",
45-
"bug"
46-
]
16+
"contributions": ["code", "doc", "bug", "review"]
4717
}
4818
]
4919
}

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,6 @@ Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds
134134

135135
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
136136
<!-- prettier-ignore -->
137-
| [<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") |
138-
| :---: | :---: | :---: |
137+
| [<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") |
138+
| :---: |
139139
<!-- ALL-CONTRIBUTORS-LIST:END -->

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Thanks for all people that support us 🙏🏻
4848

4949
## 🚀 &nbsp; Roadmap
5050

51-
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**:
51+
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**:
5252

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

117119
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):
@@ -171,6 +173,6 @@ If you need some help you can chat with us on [our Discord server](https://disco
171173

172174
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
173175
<!-- prettier-ignore -->
174-
| [<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") |
175-
| :---: | :---: | :---: |
176+
| [<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") |
177+
| :---: |
176178
<!-- ALL-CONTRIBUTORS-LIST:END -->

0 commit comments

Comments
 (0)