From 02c121817bb529a00bdfb9cf2a843382de96fa20 Mon Sep 17 00:00:00 2001 From: Jonathan Neal Date: Thu, 5 Aug 2021 18:43:56 -0400 Subject: [PATCH] update project documentation --- packages/core/README.md | 41 +++++++++++++++++++++++++++++---- packages/core/package.json | 5 ++-- packages/react/package.json | 3 ++- packages/stringify/package.json | 9 +++++--- 4 files changed, 47 insertions(+), 11 deletions(-) diff --git a/packages/core/README.md b/packages/core/README.md index fbaf5d02..3cb632af 100644 --- 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 +``` + +


+ +open in codepen + +
+ +```html + ``` ---- +


+ +open in codepen + +
+ +```js + + +``` + +


## 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 index efe346ca..3244b272 100644 --- 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 ", diff --git a/packages/react/package.json b/packages/react/package.json index 7bf83901..3713f571 100644 --- 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 index 65be4285..b6d903a7 100644 --- 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",