From f1f48c01289f6726f6455bf792b731b553a9478a Mon Sep 17 00:00:00 2001
From: Ray Epps <ray@unishine.dev>
Date: Sat, 7 Jan 2023 23:28:36 -0700
Subject: [PATCH] Improve docs + license + readme (#229)

* add repo/branch to chiller docs config

* change license to MIT

* add badges to readme
---
 LICENSE.md   | 40 +++++++++++++++++-----------------------
 README.md    | 30 ++++++++++++++++++++++++------
 chiller.json |  2 ++
 package.json |  2 +-
 4 files changed, 44 insertions(+), 30 deletions(-)

diff --git a/LICENSE.md b/LICENSE.md
index 14d567d6..ea3a1a7e 100644
--- a/LICENSE.md
+++ b/LICENSE.md
@@ -1,27 +1,21 @@
-Copyright (c) 2022, radash
-All rights reserved.
+MIT License
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
+Copyright (c) 2022 radash
 
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-* Neither the name of the copyright holder nor the names of its
-  contributors may be used to endorse or promote products derived from
-  this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
\ No newline at end of file
diff --git a/README.md b/README.md
index dd540902..ead15360 100644
--- a/README.md
+++ b/README.md
@@ -7,24 +7,42 @@
     <img src="https://github.com/rayepps/radash/raw/master/banner.png" alt="radash" width="100%" style="border-radius:4px" />
   </p>
 </div>
+
 <div>
   <h3 align="center">
     Functional utility library - modern, simple, typed, powerful
-    <br />
-    <h4 align="center">
-        <a href="https://radash-docs.vercel.app" target="_blank">
-            Full Documentation
-        </a>
-    </h4>
   </h3>
 </div>
 
+<p align="center">
+  <a href="https://bundlephobia.com/package/radash">
+    <img src="https://img.shields.io/bundlephobia/minzip/radash?label=minzipped" alt="bundle size" height="18">
+  </a>
+  <a href="https://www.npmjs.com/package/radash">
+    <img src="https://img.shields.io/npm/dm/radash.svg" alt="npm downloads" height="18">
+  </a>
+  <a href="https://www.npmjs.com/package/radash">
+    <img src="https://img.shields.io/npm/v/radash.svg" alt="npm version" height="18">
+  </a>
+  <a href="https://github.com/gvergnaud/radash">
+    <img src="https://img.shields.io/npm/l/radash.svg" alt="MIT license" height="18">
+  </a>
+</p>
+
+<div align="center">
+  <a href="https://radash-docs.vercel.app" target="_blank">
+      Full Documentation
+  </a>
+</div>
+
 ## Install
+
 ```
 yarn add radash
 ```
 
 ## Usage
+
 A very brief kitchen sink. See the full documentation [here](https://radash-docs.vercel.app).
 
 ```ts
diff --git a/chiller.json b/chiller.json
index e9c593a8..c2bf6b9f 100644
--- a/chiller.json
+++ b/chiller.json
@@ -11,6 +11,8 @@
   "index": "docs/getting-started",
   "pages": "./docs/**/*.mdx",
   "theme": "red-400",
+  "repo": "https://github.com/rayepps/radash",
+  "branch": "master",
   "sidebar": {
     "links": [
       {
diff --git a/package.json b/package.json
index ba670cc0..7eb2a180 100644
--- a/package.json
+++ b/package.json
@@ -19,7 +19,7 @@
   },
   "author": "rayepps",
   "private": false,
-  "license": "BSD-3-Clause",
+  "license": "MIT",
   "scripts": {
     "test": "jest --coverage",
     "check": "yarn lint && yarn test && yarn build",