@twotaps/site-utils-base 0.1.20 → 0.1.22

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
@@ -2,8 +2,19 @@
2
2
 
3
3
  The site-utils package contains utility code and components for building public-facing websites using Two Taps 2.0. It is available via npm at https://www.npmjs.com/package/@twotaps/site-utils for internal website use or for customers/partners.
4
4
 
5
+ ## CLI commands
6
+
7
+ ---
8
+
9
+ This package exposes the `twotaps` CLI binary.
10
+
11
+ - `twotaps generate:sdl`: Generate `schema.ts` for a schema wrapper.
12
+ - `twotaps bootstrap:site`: Bootstrap a full site from boilerplate, populate env values, generate SDL, and scaffold block components.
13
+
5
14
  ## Publish
15
+
6
16
  ---
17
+
7
18
  To publish the site-utils package on npm, you need an npm account. If you don't have one, create an account at https://www.npmjs.com/signup.
8
19
 
9
20
  You also need permission from the Two Taps 2.0 admin to publish the site-utils package. Contact the Two Taps 2.0 admin to obtain the necessary permissions.
@@ -13,15 +24,19 @@ Once you have the required permissions, run the following command:
13
24
  ```
14
25
  yarn publish
15
26
  ```
27
+
16
28
  Provide the new version, npm username, email, and password.
17
29
 
18
30
  Since site-utils is currently being used internally by the snap-fitness repository https://github.com/ltnetwork/snap-fitness-nextjs, that project needs to be updated to ensure the latest changes are available.
19
31
 
20
32
  In that repository, in `package.json` file update to the latest version:
33
+
21
34
  ```
22
35
  "@twotaps/site-utils": "^0.1.xx",
23
36
  ```
24
- Still in that project, update the project dependencies:
37
+
38
+ Still in that project, update the project dependencies:
39
+
25
40
  ```
26
41
  yarn install
27
- ```
42
+ ```