Skip to content

Commit 3076888

Browse files
committed
Docs: Added installation and size info to the readmes
1 parent 7197a49 commit 3076888

4 files changed

Lines changed: 24 additions & 2 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
## Featuring
66

7+
- [Lightweight](https://bundlephobia.com/package/@beqa/react-slots) (< 8KB
8+
minified, < 3KB minified & gzipped)
79
- Composability with ease
810
- Type-safety
911
- Server Components support
@@ -13,6 +15,15 @@
1315
- Elegant solution to a11y attributes
1416
- Inversion of control
1517

18+
## Installation
19+
20+
The installation process consists of two parts: installing the **core library**
21+
(around **3KB gzipped** piece of code that runs in your users' browsers and
22+
handles the core logic) and an optional **compile-time plugin** (for transpiling
23+
JSX syntax for your slot elements into regular function invocations).
24+
25+
[Installation steps](https://slots.beqa.site/installation)
26+
1627
## Docs
1728

1829
You can find the docs on the

docs/pages/installation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { Callout } from "nextra/components";
33
# Installation
44

55
The installation process consists of two parts: installing the **core library**
6-
(around **4kb gzipped** piece of code that runs in your users' browsers and
6+
(around **3KB gzipped** piece of code that runs in your users' browsers and
77
handles the core logic) and an optional **compile-time plugin** (for transpiling
88
JSX syntax for your slot elements into regular function invocations).
99

packages/react-slots/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
## Featuring
66

7+
- [Lightweight](https://bundlephobia.com/package/@beqa/react-slots) (< 8KB
8+
minified, < 3KB minified & gzipped)
79
- Composability with ease
810
- Type-safety
911
- Server Components support
@@ -13,6 +15,15 @@
1315
- Elegant solution to a11y attributes
1416
- Inversion of control
1517

18+
## Installation
19+
20+
The installation process consists of two parts: installing the **core library**
21+
(around **3KB gzipped** piece of code that runs in your users' browsers and
22+
handles the core logic) and an optional **compile-time plugin** (for transpiling
23+
JSX syntax for your slot elements into regular function invocations).
24+
25+
[Installation steps](https://slots.beqa.site/installation)
26+
1627
## Docs
1728

1829
You can find the docs on the

packages/react-slots/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@beqa/react-slots",
33
"private": false,
4-
"version": "1.1.2",
4+
"version": "1.1.3",
55
"description": "The react-slots runtime library",
66
"author": "Beqa",
77
"license": "MIT",

0 commit comments

Comments
 (0)