Skip to content

Commit f1f48c0

Browse files
authored
Improve docs + license + readme (#229)
* add repo/branch to chiller docs config * change license to MIT * add badges to readme
1 parent b852d2e commit f1f48c0

File tree

4 files changed

+44
-30
lines changed

4 files changed

+44
-30
lines changed

Diff for: LICENSE.md

+17-23
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,21 @@
1-
Copyright (c) 2022, radash
2-
All rights reserved.
1+
MIT License
32

4-
Redistribution and use in source and binary forms, with or without
5-
modification, are permitted provided that the following conditions are met:
3+
Copyright (c) 2022 radash
64

7-
* Redistributions of source code must retain the above copyright notice, this
8-
list of conditions and the following disclaimer.
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
911

10-
* Redistributions in binary form must reproduce the above copyright notice,
11-
this list of conditions and the following disclaimer in the documentation
12-
and/or other materials provided with the distribution.
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
1314

14-
* Neither the name of the copyright holder nor the names of its
15-
contributors may be used to endorse or promote products derived from
16-
this software without specific prior written permission.
17-
18-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19-
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20-
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21-
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
22-
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23-
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24-
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25-
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26-
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27-
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

Diff for: README.md

+24-6
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,42 @@
77
<img src="https://github.com/rayepps/radash/raw/master/banner.png" alt="radash" width="100%" style="border-radius:4px" />
88
</p>
99
</div>
10+
1011
<div>
1112
<h3 align="center">
1213
Functional utility library - modern, simple, typed, powerful
13-
<br />
14-
<h4 align="center">
15-
<a href="https://radash-docs.vercel.app" target="_blank">
16-
Full Documentation
17-
</a>
18-
</h4>
1914
</h3>
2015
</div>
2116

17+
<p align="center">
18+
<a href="https://bundlephobia.com/package/radash">
19+
<img src="https://img.shields.io/bundlephobia/minzip/radash?label=minzipped" alt="bundle size" height="18">
20+
</a>
21+
<a href="https://www.npmjs.com/package/radash">
22+
<img src="https://img.shields.io/npm/dm/radash.svg" alt="npm downloads" height="18">
23+
</a>
24+
<a href="https://www.npmjs.com/package/radash">
25+
<img src="https://img.shields.io/npm/v/radash.svg" alt="npm version" height="18">
26+
</a>
27+
<a href="https://github.com/gvergnaud/radash">
28+
<img src="https://img.shields.io/npm/l/radash.svg" alt="MIT license" height="18">
29+
</a>
30+
</p>
31+
32+
<div align="center">
33+
<a href="https://radash-docs.vercel.app" target="_blank">
34+
Full Documentation
35+
</a>
36+
</div>
37+
2238
## Install
39+
2340
```
2441
yarn add radash
2542
```
2643

2744
## Usage
45+
2846
A very brief kitchen sink. See the full documentation [here](https://radash-docs.vercel.app).
2947

3048
```ts

Diff for: chiller.json

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
"index": "docs/getting-started",
1212
"pages": "./docs/**/*.mdx",
1313
"theme": "red-400",
14+
"repo": "https://github.com/rayepps/radash",
15+
"branch": "master",
1416
"sidebar": {
1517
"links": [
1618
{

Diff for: package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
},
2020
"author": "rayepps",
2121
"private": false,
22-
"license": "BSD-3-Clause",
22+
"license": "MIT",
2323
"scripts": {
2424
"test": "jest --coverage",
2525
"check": "yarn lint && yarn test && yarn build",

0 commit comments

Comments
 (0)