update project documentation

implydata · Aug 5, 2021 · 02c1218 · 02c1218
1 parent 8581480
commit 02c1218
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 11 deletions.
diff --git a/packages/core/README.md b/packages/core/README.md
@@ -1,12 +1,43 @@
-# Stitches Core
+# @stitches/core
 
-Framework-agnostic implementation.
+**@stitches/core** is a framework-agnostic implementation of [stitches](https://stitches.dev), a CSS-in-JS library with a best-in-class developer experience.
 
 ```sh
-npm install @stitches/core
+# with npm
+npm install @stitches/react
+
+# with yarn
+yarn add @stitches/react
+```
+
+<p><br /></p>
+
+<a href="https://codepen.io/embed/prefill?editable=true&default-tab=js%2Cresult&data=%7B%22js%22%3A%22import+%7B+createStitches+%7D+from+%27https%3A%2F%2Fcdn.skypack.dev%2F%40stitches%2Fcore%27%5Cn%5Cn%2F%2F+add+your+code+here%21%5Cn%2F%2F+see+https%3A%2F%2Fstitches.dev+for+documentation%22%7D"><img src="https://img.shields.io/badge/-open_in_codepen-2b354f?logo=codepen&style=flat-square" alt="open in codepen" valign="middle" align="right"></a>
+
+<br />
+
+```html
+<script type="module">
+  import { createStitches } from 'https://cdn.skypack.dev/@stitches/core'
+
+  const { css } = createStitches()
+</script>
 ```
 
----
+<p><br /></p>
+
+<a href="https://codepen.io/embed/prefill?editable=true&default-tab=js%2Cresult&data=%7B%22js%22%3A%22stitches.createStitches%5Cn%5Cn%2F%2F+add+your+code+here%21%5Cn%2F%2F+see+https%3A%2F%2Fstitches.dev+for+documentation%22%2C%22js_external%22%3A%22https%3A%2F%2Fcdn.skypack.dev%2F%40stitches%2Fcore%2Fglobal%22%7D"><img src="https://img.shields.io/badge/-open_in_codepen-2b354f?logo=codepen&style=flat-square" alt="open in codepen" valign="middle" align="right"></a>
+
+<br />
+
+```js
+<script src="https://cdn.skypack.dev/@stitches/core/global"></script>
+<script>
+const { css } = stitches.createStitches()
+</script>
+```
+
+<p><br /></p>
 
 ## Documentation
 
@@ -19,8 +50,8 @@ Please follow our [contributing guidelines](./CONTRIBUTING.md).
 ## Authors
 
 - Pedro Duarte ([@peduarte](https://twitter.com/peduarte)) - [Modulz](https://modulz.app)
-- Jonathan Neal ([@jon_neal](https://twitter.com/jon_neal)) - [Modulz](https://modulz.app)
 - Abdulhadi Alhallak ([@hadi_hlk](https://twitter.com/hadi_hlk)) - [Modulz](https://modulz.app)
+- Jonathan Neal ([@jon_neal](https://twitter.com/jon_neal)) - [Modulz](https://modulz.app)
 
 ## License
 

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -20,7 +20,8 @@
       "require": "./dist/index.cjs",
       "import": "./dist/index.mjs",
       "types": "./types/index.d.ts"
-    }
+    },
+    "./global": "./dist/index.global.js"
   },
   "files": [
     "dist",
@@ -30,7 +31,7 @@
   "sideEffects": false,
   "license": "MIT",
   "repository": "modulz/stitches",
-  "homepage": "https://github.com/modulz/stitches#readme",
+  "homepage": "https://stitches.dev/",
   "bugs": "https://github.com/modulz/stitches/issues",
   "contributors": [
     "Pedro Duarte <pedro@modulz.app>",

diff --git a/packages/react/package.json b/packages/react/package.json
@@ -20,7 +20,8 @@
       "require": "./dist/index.cjs",
       "import": "./dist/index.mjs",
       "types": "./types/index.d.ts"
-    }
+    },
+    "./global": "./dist/index.global.js"
   },
   "files": [
     "dist",

diff --git a/packages/stringify/package.json b/packages/stringify/package.json
@@ -9,9 +9,12 @@
   "jsdelivr": "dist/index.global.js",
   "unpkg": "dist/index.global.js",
   "exports": {
-    "require": "./dist/index.cjs",
-    "import": "./dist/index.mjs",
-    "default": "./dist/index.mjs"
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.mjs",
+      "types": "./types/index.d.ts"
+    },
+    "./global": "./dist/index.global.js"
   },
   "files": [
     "dist",