@tresjs/cientos 2.0.0-alpha.4 → 2.0.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -22,19 +22,68 @@ The cientos package uses three-stdlib module under the hood instead of the three
22
22
 
23
23
  It just works. 💯
24
24
 
25
+ ## Installation
26
+
27
+ ```bash
28
+ pnpm i @tresjs/cientos
29
+ ```
25
30
 
26
31
  ## Docs
27
32
 
28
- Checkout the [docs](https://tresjs.org/cientos/)
33
+ Checkout the [docs](https://cientos.tresjs.org/)
29
34
 
30
35
  ## Demos
31
36
 
32
37
  - [Stackblitz Collection](https://stackblitz.com/@alvarosabu/collections/tresjs)
33
38
 
34
- ## Contribution
39
+ ## Contributing
35
40
 
36
41
  We are open to contributions, please read the [contributing guide](/CONTRIBUTING.md) to get started.
37
42
 
43
+ ### Build
44
+
45
+ To build the package run:
46
+
47
+ ```bash
48
+ pnpm run build
49
+ ```
50
+
51
+ ### Playground
52
+
53
+
54
+ To run the playground run, its a great way to test the components and helpers locally:
55
+
56
+ First install dependencies
57
+
58
+ ```
59
+ pnpm i
60
+ ```
61
+
62
+ And then to run the development server on http://localhost:5173
63
+
64
+ ```bash
65
+ pnpm run playground
66
+ ```
67
+
68
+ ### Test
69
+
70
+ TODO...
71
+
72
+ ### Docs
73
+
74
+ To run de docs in dev mode
75
+
76
+ ```bash
77
+ pnpm run docs:dev
78
+ ```
79
+
80
+ To build them
81
+
82
+ ```bash
83
+ pnpm run docs:build
84
+ ```
85
+
86
+
38
87
  ## License
39
88
 
40
89
  [MIT](/LICENSE)