@plumeria/core 0.8.2 → 0.8.4

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 (3) hide show
  1. package/LICENSE +21 -0
  2. package/package.json +9 -9
  3. package/readme.md +14 -7
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) zss-in-js contributer
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@plumeria/core",
3
- "version": "0.8.2",
3
+ "version": "0.8.4",
4
4
  "description": "Zero-runtime StyleSheet for speedy development cycle",
5
5
  "keywords": [
6
6
  "css",
@@ -39,18 +39,18 @@
39
39
  "types/",
40
40
  "stylesheet/"
41
41
  ],
42
- "scripts": {
43
- "build": "rimraf dist types && pnpm esm && pnpm cjs",
44
- "cjs": "tsc --project tsconfig.cjs.json",
45
- "esm": "tsc --project tsconfig.esm.json"
46
- },
47
42
  "dependencies": {
48
- "zss-utils": "0.0.8"
43
+ "zss-utils": "0.1.0"
49
44
  },
50
45
  "peerDependencies": {
51
- "@plumeria/compiler": ">=0.8.2"
46
+ "@plumeria/compiler": ">=0.8.4"
52
47
  },
53
48
  "publishConfig": {
54
49
  "access": "public"
50
+ },
51
+ "scripts": {
52
+ "build": "rimraf dist types && pnpm esm && pnpm cjs",
53
+ "cjs": "tsc --project tsconfig.cjs.json",
54
+ "esm": "tsc --project tsconfig.esm.json"
55
55
  }
56
- }
56
+ }
package/readme.md CHANGED
@@ -1,10 +1,10 @@
1
- # 💐 Plumeria
1
+ # @plumeria/core
2
2
 
3
3
  Plumeria is a CSS-in-JS built with [**zss-utils**](https://www.npmjs.com/package/zss-utils) that provides a speedy development cycle.
4
4
 
5
5
  ## Installation
6
6
 
7
- To start using Plumeria, install the following two packages:
7
+ To start using Plumeria, Install the following two packages and the bundler package:
8
8
 
9
9
  ```sh
10
10
  npm install @plumeria/core
@@ -12,24 +12,32 @@ npm install @plumeria/core
12
12
 
13
13
  ### Compiler
14
14
 
15
- To compile @plumeria/core, for example, to use `npx css`, install
16
- [`@plumeria/compiler`](https://www.npmjs.com/package/@plumeria/compiler) for static extraction through the Command-line.
17
- Also, it can be easily integrated(`css &&`) into the build process.
15
+ Plumeria is designed to extract styles into static CSS stylesheets using the CLI.
16
+ Install the following libraries to enable CLI commands: [`@plumeria/compiler`](https://www.npmjs.com/package/@plumeria/compiler)
18
17
 
19
18
  ```sh
20
19
  npm install --save-dev @plumeria/compiler
21
20
  ```
22
21
 
22
+ For more information on compiler commnads, please see the documentation
23
+ [API reference](https://plumeria.dev/docs/reference/css).
24
+
23
25
  ### Static StyleSheet
24
26
 
25
27
  Import stylesheet in your application's entry point.
26
- CSS for all APIs is collected here.
27
28
  Applies the static stylesheet for production environments.
28
29
 
29
30
  ```ts
31
+ // eg: main.ts or layout.tsx
30
32
  import '@plumeria/core/stylesheet';
31
33
  ```
32
34
 
35
+ ### Integrate
36
+
37
+ To integrate with Next.js or Vite, you'll need one of the following packages:
38
+ [@plumeria/next](https://www.npmjs.com/package/@plumeria/next) or [@plumeria/vite](https://www.npmjs.com/package/@plumeria/vite).
39
+ See [Installation](https://plumeria.dev/docs/getting-started/installation) in the documentation for more details.
40
+
33
41
  ## API
34
42
 
35
43
  ### css.create()
@@ -74,7 +82,6 @@ const styles = css.create({
74
82
  ### css.global()
75
83
 
76
84
  This API lets you define global CSS.
77
- \*Please be careful not to create selectors that conflict by creating more than one global object.
78
85
 
79
86
  ```ts
80
87
  css.global({