update project documentation

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

Hide file tree

Showing 2 changed files with 40 additions and 5 deletions.
diff --git a/packages/core/README.md b/packages/core/README.md
@@ -2,12 +2,14 @@
 
 **@stitches/core** is a framework-agnostic implementation of [stitches](https://stitches.dev), a CSS-in-JS library with a best-in-class developer experience.
 
+<p><br /></p>
+
 ```sh
 # with npm
-npm install @stitches/react
+npm install @stitches/core
 
 # with yarn
-yarn add @stitches/react
+yarn add @stitches/core
 ```
 
 <p><br /></p>

diff --git a/packages/react/README.md b/packages/react/README.md
@@ -1,12 +1,45 @@
-# Stitches React
+# @stitches/react
 
-React wrapper including the `styled` API.
+**@stitches/react** is a react implementation of [stitches](https://stitches.dev), a CSS-in-JS library with a best-in-class developer experience.
+
+<p><br /></p>
 
 ```sh
+# 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%2Freact%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/react'
+
+  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%2Freact%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/react/global"></script>
+<script>
+const { css } = stitches.createStitches()
+</script>
 ```
 
----
+<p><br /></p>
 
 ## Documentation