@salty-css/react 0.0.1-alpha.33 → 0.0.1-alpha.34

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.
Files changed (2) hide show
  1. package/README.md +9 -3
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # Salty CSS - Kinda sweet but yet spicy CSS-in-JS library 🧂
1
+ # Salty CSS - Kinda sweet but yet spicy CSS-in-JS library
2
2
 
3
3
  In the world of frontend dev is there anything saltier than CSS? Salty CSS is built to provide better developer experience for developers looking for performant and feature rich CSS-in-JS solutions.
4
4
 
@@ -12,11 +12,17 @@ In the world of frontend dev is there anything saltier than CSS? Salty CSS is bu
12
12
 
13
13
  ## Get started
14
14
 
15
+ ### TL;DR
16
+
17
+ - Initialize: `npx salty-css init [directory]`
18
+ - Create component: `npx salty-css generate [filePath]`
19
+ - Build: `npx salty-css build [directory]`
20
+
15
21
  ### Quick way of using `salty-css` CLI
16
22
 
17
23
  #### Initialize Salty CSS for a project
18
24
 
19
- In your repository run `npx salty-css init [directory]` which installs required salty-css packages to the current directory and creates project files to the provided directory. Directory can be left blank if you want files to be created to the current directory.
25
+ In your existing repository run `npx salty-css init [directory]` which installs required salty-css packages to the current directory and creates project files to the provided directory. Directory can be left blank if you want files to be created to the current directory. Init will also create `.saltyrc` which contains some metadata for future CLI commands.
20
26
 
21
27
  #### Create components
22
28
 
@@ -24,7 +30,7 @@ Components can be created with `npx salty-css generate [filePath]` which then cr
24
30
 
25
31
  #### Build / Compile Salty CSS
26
32
 
27
- If you want to manually build your project that can be done by running `npx salty-css build [directory]`
33
+ If you want to manually build your project that can be done by running `npx salty-css build [directory]`. Directory is not required as CLI can use default directory defined in `.saltyrc`. Note that build generates css files but Vite / Webpack plugin is still required for full support.
28
34
 
29
35
  #### Update Salty CSS packages
30
36
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@salty-css/react",
3
- "version": "0.0.1-alpha.33",
3
+ "version": "0.0.1-alpha.34",
4
4
  "main": "./dist/index.js",
5
5
  "module": "./dist/index.mjs",
6
6
  "typings": "./dist/index.d.ts",
@@ -41,7 +41,7 @@
41
41
  }
42
42
  },
43
43
  "dependencies": {
44
- "@salty-css/core": "^0.0.1-alpha.33",
44
+ "@salty-css/core": "^0.0.1-alpha.34",
45
45
  "clsx": ">=2.x",
46
46
  "react": ">=19.x || >=18.3.x"
47
47
  }