Skip to content

Commit 8d9f1e0

Browse files
committed
readme updates for beta release
1 parent feb236f commit 8d9f1e0

File tree

5 files changed

+2148
-2114
lines changed

5 files changed

+2148
-2114
lines changed

packages/docs/docs/getstarted.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,6 @@ sidebar_position: 0
88

99
import { DemoBox } from "../src/components/demo/demo-box";
1010

11-
:::danger[A note on stability]
12-
13-
This project is currently in Alpha. Expect breaking changes in minor version bumps and incomplete changelogs.
14-
Bug reports and contributions are welcome!
15-
16-
:::
17-
1811
## Installation
1912

2013
To start using Headless Tree, install it to your project as dependency via
@@ -33,6 +26,13 @@ During Alpha, releases are published on an irregular basis, and changelogs may n
3326
The current main branch is always published to NPM under the `snapshot` tag, so you can use
3427
`npm install @headless-tree/core@snapshot @headless-tree/react@snapshot` to get the latest snapshot deployment.
3528

29+
:::tip[Headless Tree is available!]
30+
31+
Headless Tree is now available as Beta! If the library provides you with a benefit, leaving [a star
32+
on Github](https://github.com/lukasbach/headless-tree) would help a lot with the visibility of the project.
33+
34+
:::
35+
3636
## Quick Start
3737

3838
The React Bindings of Headless Tree provide a hook `useTree` that creates a tree instance, which you can use

packages/docs/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
"prism-react-renderer": "^2.3.0",
2323
"react": "^18.0.0",
2424
"react-dom": "^18.0.0",
25+
"react-icons": "^5.5.0",
2526
"react-syntax-highlighter": "^15.5.0"
2627
},
2728
"devDependencies": {

packages/docs/src/pages/index.module.css

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,16 @@
6060
display: flex;
6161
align-items: center;
6262
justify-content: center;
63+
gap: 8px;
64+
}
65+
66+
.socialBtn {
67+
height: 47px;
68+
width: 80px;
69+
padding: 0;
70+
display: flex;
71+
align-items: center;
72+
justify-content: center;
6373
}
6474

6575
.demoBox {

packages/docs/src/pages/index.tsx

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@ import Link from "@docusaurus/Link";
33
import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
44
import Layout from "@theme/Layout";
55
import Heading from "@theme/Heading";
6-
76
import { storybookRoot } from "@site/src/components/demo/demo-box";
87
import { DemoGrid } from "@site/src/components/home/demo-grid";
98
import { HomeNotes } from "@site/src/components/home/home-notes";
9+
import { RiBlueskyFill } from "react-icons/ri";
10+
import { BsDiscord } from "react-icons/bs";
1011
import styles from "./index.module.css";
1112

1213
function HomepageHeader() {
@@ -36,6 +37,18 @@ function HomepageHeader() {
3637
>
3738
Get Started
3839
</Link>
40+
<Link
41+
className={`button button--outline button--secondary button--lg ${styles.socialBtn}`}
42+
to="https://discord.gg/KuZ6EezzVw"
43+
>
44+
<BsDiscord size="2rem" />
45+
</Link>
46+
<Link
47+
className={`button button--outline button--secondary button--lg ${styles.socialBtn}`}
48+
to="https://bsky.app/profile/lukasbach.bsky.social"
49+
>
50+
<RiBlueskyFill size="2rem" />
51+
</Link>
3952
</div>
4053
</div>
4154
<div className={styles.heroRight}>

0 commit comments

Comments
 (0)