Skip to content

Commit 9d430c4

Browse files
committed
docs: minimal readme
1 parent 8ee1b61 commit 9d430c4

File tree

1 file changed

+40
-32
lines changed

1 file changed

+40
-32
lines changed

README.MD

Lines changed: 40 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,46 @@
1-
[![npm](https://img.shields.io/npm/v/@formidable-webview/webshell/latest)](https://www.npmjs.com/package/@formidable-webview/webshell)
2-
[![npm](https://img.shields.io/npm/v/@formidable-webview/webshell/next)](https://www.npmjs.com/package/@formidable-webview/webshell)
3-
[![semver](https://img.shields.io/badge/semver-2.0.0-e10079.svg)](https://semver.org/spec/v2.0.0.html)
4-
[![codecov](https://codecov.io/gh/formidable-webview/webshell/branch/master/graph/badge.svg)](https://codecov.io/gh/formidable-webview/webshell)
5-
[![](https://img.shields.io/discord/757572391663566870?label=discord)](https://discord.gg/XV3zt3d)
1+
<p align="center">
2+
<a href="https://www.npmjs.com/package/@formidable-webview/webshell"
3+
><img
4+
src="https://img.shields.io/npm/v/@formidable-webview/webshell/latest"
5+
alt="npm"
6+
/></a>
7+
<a href="https://www.npmjs.com/package/@formidable-webview/webshell"
8+
><img
9+
src="https://img.shields.io/npm/v/@formidable-webview/webshell/next"
10+
alt="npm"
11+
/></a>
12+
<a href="https://semver.org/spec/v2.0.0.html"
13+
><img
14+
src="https://img.shields.io/badge/semver-2.0.0-e10079.svg"
15+
alt="semver"
16+
/></a>
17+
<a href="https://codecov.io/gh/formidable-webview/webshell"
18+
><img
19+
src="https://codecov.io/gh/formidable-webview/webshell/branch/master/graph/badge.svg"
20+
alt="codecov"
21+
/></a>
22+
<a href="https://discord.gg/XV3zt3d"
23+
><img
24+
src="https://img.shields.io/discord/757572391663566870?label=discord"
25+
alt="discord"
26+
/></a>
27+
<a
28+
href="https://github.com/formidable-webview/webshell/actions?query=branch%3Amaster+workflow%3ACI"
29+
><img
30+
src="https://github.com/formidable-webview/webshell/workflows/CI/badge.svg?branch=master"
31+
alt="CI"
32+
/></a>
33+
</p>
634

735
<h1 align="center">@formidable-webview/webshell</h1>
836

937
<p align="center">
1038
:fire: Craft Robust React Native WebView-based components with ease.
11-
<br/><br/>
12-
<a href="https://formidable-webview.github.io/webshell/"><img src="./assets/api-quickview.png" width="350" /></a>
13-
39+
<br /><br />
40+
<a href="https://formidable-webview.github.io/webshell/"
41+
><img src="./assets/api-quickview.png" width="350"
42+
/></a>
43+
<br/>
44+
<br/>
45+
<strong><a href="https://formidable-webview.github.io/webshell/">Check out our website!</a></strong>
1446
</p>
15-
16-
## Build Status
17-
18-
| Branch | Status |
19-
| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
20-
| master | [![CI](https://github.com/formidable-webview/webshell/workflows/CI/badge.svg?branch=master)](https://github.com/formidable-webview/webshell/actions?query=branch%3Amaster+workflow%3ACI) |
21-
| dev/1.x | [![CI](https://github.com/formidable-webview/webshell/workflows/CI/badge.svg?branch=dev/1.x)](https://github.com/formidable-webview/webshell/actions?query=branch%3Adev%2F1.x) |
22-
23-
## Install
24-
25-
```sh
26-
# With npm
27-
npm add --save @formidable-webview/webshell
28-
# With yarn
29-
yarn add @formidable-webview/webshell
30-
```
31-
32-
## Documentation
33-
34-
[See our official website](https://formidable-webview.github.io/webshell/).
35-
36-
## Changelog
37-
38-
[packages/webshell/CHANGELOG.MD](packages/webshell/CHANGELOG.MD)

0 commit comments

Comments
 (0)