Skip to content
This repository was archived by the owner on Jun 20, 2022. It is now read-only.

Commit 48f4bf4

Browse files
committed
docs(readme): add readme in projects
1 parent d4fb2cd commit 48f4bf4

File tree

3 files changed

+76
-21
lines changed

3 files changed

+76
-21
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,10 @@
66
<p align="center" style="font-size: 1.2rem;">Modern React UI library. Code less, do more.</p>
77

88
[![Build Status][build-badge]][build]
9-
10-
<!-- [![Code Coverage][coverage-badge]][coverage] -->
11-
129
[![Version][version-badge]][package]
1310
[![MIT License][license-badge]][license]
1411
[![Small size][size-badge]][build-min]
1512

16-
<!-- [![PRs Welcome][prs-badge]][prs] -->
17-
18-
<!-- [![Watch on GitHub][github-watch-badge]][github-watch] -->
19-
20-
<!-- [![Star on GitHub][github-star-badge]][github-star] -->
21-
22-
<!-- [![Tweet][twitter-badge]][twitter] -->
23-
2413
```sh
2514
npm install @smooth-ui/core-sc styled-components
2615
```
@@ -47,19 +36,9 @@ See [LICENSE](./LICENSE) for more information.
4736

4837
[build-badge]: https://img.shields.io/travis/smooth-code/smooth-ui.svg?style=flat-square
4938
[build]: https://travis-ci.org/smooth-code/smooth-ui
50-
[coverage-badge]: https://img.shields.io/codecov/c/github/smooth-code/smooth-ui.svg?style=flat-square
51-
[coverage]: https://codecov.io/github/smooth-code/smooth-ui
5239
[version-badge]: https://img.shields.io/npm/v/@smooth-ui/core-sc.svg?style=flat-square
5340
[package]: https://www.npmjs.com/package/@smooth-ui/core-sc
5441
[license-badge]: https://img.shields.io/npm/l/@smooth-ui/core-sc.svg?style=flat-square
5542
[license]: https://github.com/smooth-code/smooth-ui/blob/master/LICENSE
56-
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
57-
[prs]: http://makeapullrequest.com
58-
[github-watch-badge]: https://img.shields.io/github/watchers/smooth-code/smooth-ui.svg?style=social
59-
[github-watch]: https://github.com/smooth-code/smooth-ui/watchers
60-
[github-star-badge]: https://img.shields.io/github/stars/smooth-code/smooth-ui.svg?style=social
61-
[github-star]: https://github.com/smooth-code/smooth-ui/stargazers
62-
[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20Smooth%20UI!%20https://github.com/smooth-code/smooth-ui%20%F0%9F%91%8D
63-
[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/smooth-code/smooth-ui.svg?style=social
6443
[size-badge]: https://img.badgesize.io/https://unpkg.com/@smooth-ui/core-sc/dist/smooth-ui.min.js?compression=gzip&style=flat-square
6544
[build-min]: https://unpkg.com/@smooth-ui/core-sc/dist/smooth-ui.min.js

β€Žpackages/core-em/README.mdβ€Ž

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<h1 align="center">
2+
<a target="_blank" href="https://smooth-ui.smooth-code.com">
3+
<img src="https://raw.githubusercontent.com/smooth-code/smooth-ui/master/resources/smooth-ui-logo.png?token=AAQQPuM4Puh4DdUkTB1OufRD9oW_EOHzks5agcuiwA%3D%3D" alt="smooth-ui" title="smooth-ui" width="300">
4+
</a>
5+
</h1>
6+
<p align="center" style="font-size: 1.2rem;">Modern React UI library. Code less, do more.</p>
7+
8+
[![Build Status][build-badge]][build]
9+
[![Version][version-badge]][package]
10+
[![MIT License][license-badge]][license]
11+
[![Small size][size-badge]][build-min]
12+
13+
```sh
14+
npm install @smooth-ui/core-em react-emotion emotion-theming
15+
```
16+
17+
Smooth UI is a style system / UI library for [React](https://reactjs.org/). It works with [Styled Components πŸ’…](https://www.styled-components.com) or [Emotion πŸ‘©β€πŸŽ€](https://emotion.sh/).
18+
19+
It is focused on developer experience, productivity. You can focus on what you want to build instead of on how to build it.
20+
21+
## [Docs](https://smooth-ui.smooth-code.com/)
22+
23+
**See the documentation at [smooth-ui.smooth-code.com](https://smooth-ui.smooth-code.com/)** for more information about using Smooth UI!
24+
25+
## License
26+
27+
Licensed under the MIT License, Copyright Β© 2018-present Smooth Code.
28+
29+
See [LICENSE](./LICENSE) for more information.
30+
31+
[build-badge]: https://img.shields.io/travis/smooth-code/smooth-ui.svg?style=flat-square
32+
[build]: https://travis-ci.org/smooth-code/smooth-ui
33+
[version-badge]: https://img.shields.io/npm/v/@smooth-ui/core-sc.svg?style=flat-square
34+
[package]: https://www.npmjs.com/package/@smooth-ui/core-sc
35+
[license-badge]: https://img.shields.io/npm/l/@smooth-ui/core-sc.svg?style=flat-square
36+
[license]: https://github.com/smooth-code/smooth-ui/blob/master/LICENSE
37+
[size-badge]: https://img.badgesize.io/https://unpkg.com/@smooth-ui/core-sc/dist/smooth-ui.min.js?compression=gzip&style=flat-square
38+
[build-min]: https://unpkg.com/@smooth-ui/core-sc/dist/smooth-ui.min.js

β€Žpackages/core-sc/README.mdβ€Ž

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<h1 align="center">
2+
<a target="_blank" href="https://smooth-ui.smooth-code.com">
3+
<img src="https://raw.githubusercontent.com/smooth-code/smooth-ui/master/resources/smooth-ui-logo.png?token=AAQQPuM4Puh4DdUkTB1OufRD9oW_EOHzks5agcuiwA%3D%3D" alt="smooth-ui" title="smooth-ui" width="300">
4+
</a>
5+
</h1>
6+
<p align="center" style="font-size: 1.2rem;">Modern React UI library. Code less, do more.</p>
7+
8+
[![Build Status][build-badge]][build]
9+
[![Version][version-badge]][package]
10+
[![MIT License][license-badge]][license]
11+
[![Small size][size-badge]][build-min]
12+
13+
```sh
14+
npm install @smooth-ui/core-sc styled-components
15+
```
16+
17+
Smooth UI is a style system / UI library for [React](https://reactjs.org/). It works with [Styled Components πŸ’…](https://www.styled-components.com) or [Emotion πŸ‘©β€πŸŽ€](https://emotion.sh/).
18+
19+
It is focused on developer experience, productivity. You can focus on what you want to build instead of on how to build it.
20+
21+
## [Docs](https://smooth-ui.smooth-code.com/)
22+
23+
**See the documentation at [smooth-ui.smooth-code.com](https://smooth-ui.smooth-code.com/)** for more information about using Smooth UI!
24+
25+
## License
26+
27+
Licensed under the MIT License, Copyright Β© 2018-present Smooth Code.
28+
29+
See [LICENSE](./LICENSE) for more information.
30+
31+
[build-badge]: https://img.shields.io/travis/smooth-code/smooth-ui.svg?style=flat-square
32+
[build]: https://travis-ci.org/smooth-code/smooth-ui
33+
[version-badge]: https://img.shields.io/npm/v/@smooth-ui/core-sc.svg?style=flat-square
34+
[package]: https://www.npmjs.com/package/@smooth-ui/core-sc
35+
[license-badge]: https://img.shields.io/npm/l/@smooth-ui/core-sc.svg?style=flat-square
36+
[license]: https://github.com/smooth-code/smooth-ui/blob/master/LICENSE
37+
[size-badge]: https://img.badgesize.io/https://unpkg.com/@smooth-ui/core-sc/dist/smooth-ui.min.js?compression=gzip&style=flat-square
38+
[build-min]: https://unpkg.com/@smooth-ui/core-sc/dist/smooth-ui.min.js

0 commit comments

Comments
Β (0)