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

Commit 82966b9

Browse files
committed
docs(readme): add key features, remove unecessary badges
1 parent 955b9db commit 82966b9

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,11 @@
77
<h4>Blazing fast semantic helper components for working with <a href="https://reactjs.org/" target="_blank">React</a>.</h4>
88

99
<p>
10-
<a href="https://badge.fury.io/js/react-semantics">
11-
<img src="https://badge.fury.io/js/react-semantics.svg" alt="npm package" />
10+
<a href="https://www.npmjs.com/package/react-semantics">
11+
<img src="https://img.shields.io/npm/v/react-semantics.svg" alt="npm package" />
12+
</a>
13+
<a href="https://bundlephobia.com/result?p=react-semantics">
14+
<img src="https://img.shields.io/bundlephobia/min/react-semantics.svg" alt="bundle size" />
1215
</a>
1316
<a href="https://travis-ci.com/csvenke/react-semantics">
1417
<img src="https://travis-ci.com/csvenke/react-semantics.svg?branch=master" alt="build status" />
@@ -19,26 +22,29 @@
1922
<a href="https://david-dm.org/csvenke/react-semantics">
2023
<img src="https://david-dm.org/csvenke/react-semantics.svg" alt="dependencies status" />
2124
</a>
22-
<a href="https://david-dm.org/csvenke/react-semantics?type=dev">
23-
<img src="https://david-dm.org/csvenke/react-semantics/dev-status.svg" alt="devdependencies status" />
24-
</a>
25-
<a href="https://greenkeeper.io/">
26-
<img src="https://badges.greenkeeper.io/csvenke/react-semantics.svg" alt="greenkeeper" />
27-
</a>
2825
</p>
2926

3027
<p>
28+
<a href="#key-features">Key features</a> •
3129
<a href="#install">Install</a> •
3230
<a href="#example-usage">Example usage</a> •
3331
<a href="#why">Why?</a> •
3432
<a href="#documentation">Documentation</a> •
35-
<a href="#development-setup">Development setup</a> •
33+
<a href="#development">Development</a> •
3634
<a href="#contributing">Contributing</a> •
3735
<a href="#contributors">Contributors</a> •
3836
<a href="#license">License</a>
3937
</p>
38+
4039
</div>
4140

41+
## Key features
42+
43+
* __Blazing fast!__
44+
* __Small bundle size!__
45+
* __Typescript definition files!__
46+
* __Above 90% test coverage!__
47+
4248
## Install
4349

4450
```bash
@@ -102,7 +108,7 @@ Do you have an idea about a component you think belong here? [Tell us here!](htt
102108

103109
For full list of components and how they are used, go to our [documentation](https://csvenke.github.io/react-semantics/).
104110

105-
## Development setup
111+
## Development
106112

107113
```bash
108114
# Install dependencies
@@ -121,11 +127,12 @@ $ npm run build
121127
## Contributing
122128

123129
In lieu of a formal styleguide, take care to maintain the existing coding style.
130+
124131
* Add unit tests for any new or changed functionality.
125132
* All library component props must be documented with jsdoc `/** */`, so that typescript definition files can be generated.
126133
* All library components must have `prop-types` that matches the component props interface.
127134

128-
### Commit style guide
135+
#### Commit style guide
129136
We use [conventional commits style](https://conventionalcommits.org/).
130137
Read up on it before doing your first commit.
131138
Don't worry about making a mistake, `commitlint` will stop you if you do, and you can try again.

0 commit comments

Comments
 (0)