Docs: Added installation and size info to the readmes

Flammae · Feb 16, 2024 · 3076888 · 3076888
1 parent 7197a49
commit 3076888
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,8 @@
 
 ## Featuring
 
+- [Lightweight](https://bundlephobia.com/package/@beqa/react-slots) (< 8KB
+  minified, < 3KB minified & gzipped)
 - Composability with ease
 - Type-safety
 - Server Components support
@@ -13,6 +15,15 @@
 - Elegant solution to a11y attributes
 - Inversion of control
 
+## Installation
+
+The installation process consists of two parts: installing the **core library**
+(around **3KB gzipped** piece of code that runs in your users' browsers and
+handles the core logic) and an optional **compile-time plugin** (for transpiling
+JSX syntax for your slot elements into regular function invocations).
+
+[Installation steps](https://slots.beqa.site/installation)
+
 ## Docs
 
 You can find the docs on the

diff --git a/docs/pages/installation.mdx b/docs/pages/installation.mdx
@@ -3,7 +3,7 @@ import { Callout } from "nextra/components";
 # Installation
 
 The installation process consists of two parts: installing the **core library**
-(around **4kb gzipped** piece of code that runs in your users' browsers and
+(around **3KB gzipped** piece of code that runs in your users' browsers and
 handles the core logic) and an optional **compile-time plugin** (for transpiling
 JSX syntax for your slot elements into regular function invocations).
 

diff --git a/packages/react-slots/README.md b/packages/react-slots/README.md
@@ -4,6 +4,8 @@
 
 ## Featuring
 
+- [Lightweight](https://bundlephobia.com/package/@beqa/react-slots) (< 8KB
+  minified, < 3KB minified & gzipped)
 - Composability with ease
 - Type-safety
 - Server Components support
@@ -13,6 +15,15 @@
 - Elegant solution to a11y attributes
 - Inversion of control
 
+## Installation
+
+The installation process consists of two parts: installing the **core library**
+(around **3KB gzipped** piece of code that runs in your users' browsers and
+handles the core logic) and an optional **compile-time plugin** (for transpiling
+JSX syntax for your slot elements into regular function invocations).
+
+[Installation steps](https://slots.beqa.site/installation)
+
 ## Docs
 
 You can find the docs on the

diff --git a/packages/react-slots/package.json b/packages/react-slots/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@beqa/react-slots",
   "private": false,
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "The react-slots runtime library",
   "author": "Beqa",
   "license": "MIT",