Skip to content

Commit 77ac599

Browse files
committed
docs: add missing readme files
Signed-off-by: Andres Correa Casablanca <castarco@coderspirit.xyz>
1 parent 13d608d commit 77ac599

File tree

4 files changed

+53
-1
lines changed

4 files changed

+53
-1
lines changed

@beautiful-tree/algorithms/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Beautiful-Tree Algorithms
2+
3+
## Other members of the family
4+
5+
This is the "core" of the BeautifulTree library. If you are looking for
6+
for integration with other technologies such as React or Vue, check the
7+
[main README.md](https://github.com/Coder-Spirit/beautiful-tree?tab=readme-ov-file#beautiful-tree)
8+
file of the project's repository.
9+
10+
## Install
11+
12+
```bash
13+
# With NPM
14+
npm install @beautiful-tree/algorithms
15+
16+
# With Yarn
17+
yarn add @beautiful-tree/algorithms
18+
19+
# With PNPM
20+
pnpm add @beautiful-tree/algorithms
21+
```
22+
23+
## Basic Usage
24+
25+
TODO: Document algorithms library

@beautiful-tree/react/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Some of its hightlights:
1515
- Very lightweight (3.9Kb in its minimised ESM form, and 4.2Kb in its UMD form)
1616
- The generated trees can be styled with CSS
1717

18-
## React Variant
18+
## Other members of the family
1919

2020
This is the "React variant" of the BeautifulTree library. If you are looking
2121
for integration with other technologies such as Vue, check the

@beautiful-tree/types/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Beautiful-Tree Types
2+
3+
## Other members of the family
4+
5+
This is the "types lib" of the BeautifulTree library. If you are looking for
6+
for integration with other technologies such as React or Vue, check the
7+
[main README.md](https://github.com/Coder-Spirit/beautiful-tree?tab=readme-ov-file#beautiful-tree)
8+
file of the project's repository.
9+
10+
## Install
11+
12+
```bash
13+
# With NPM
14+
npm install @beautiful-tree/types
15+
16+
# With Yarn
17+
yarn add @beautiful-tree/types
18+
19+
# With PNPM
20+
pnpm add @beautiful-tree/types
21+
```
22+
23+
## Basic Usage
24+
25+
TODO: Document types library

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ technologies such as Vue.
2020

2121
## Packages in this repository:
2222

23+
- [@beautiful-tree/algorithms](@beautiful-tree/algorithms/README.md)
2324
- [@beautiful-tree/react](@beautiful-tree/react/README.md)
25+
- [@beautiful-tree/types](@beautiful-tree/types/README.md)
2426

2527
## Community
2628

0 commit comments

Comments
 (0)