Rename package to @primer/primitives

CHANGELOG.md

@@ -1,10 +1,15 @@
+# 2.0.0 (2019-10-21)
+
+#### :rotating_light: Breaking Changes
+* [#14](https://github.com/primer/primitives/pull/14) Rename npm package to `@primer/primitives` and deprecate old `primer-*` packages ([@BinaryMuse](https://github.com/BinaryMuse))
+
 # 1.0.2 (2018-07-20)
 
 #### :bug: Bug Fix
-* [#3](https://github.com/primer/primer-primitives/pull/6) Fix spacing to be an array instead of an object. ([@broccolini](https://github.com/broccolini))
+* [#6](https://github.com/primer/primer-primitives/pull/6) Fix spacing to be an array instead of an object. ([@broccolini](https://github.com/broccolini))
 
 #### :memo: Documentation
-* [#3](https://github.com/primer/primer-primitives/pull/6) Add usage example to README. ([@broccolini](https://github.com/broccolini))
+* [#6](https://github.com/primer/primer-primitives/pull/6) Add usage example to README. ([@broccolini](https://github.com/broccolini))
 
 # 1.0.1 (2018-05-10)
 
@@ -18,5 +23,5 @@
 # 1.0.0 (2018-04-29)
 
 #### :rocket: Enhancement
-* [#2](https://github.com/primer/primer-primitives/pull/1) Add color, typography, and spacing packages. ([@broccolini](https://github.com/broccolini))
-* [#2](https://github.com/primer/primer-primitives/pull/1) Add primer-primitives package that imports all primitives. ([@broccolini](https://github.com/broccolini))
+* [#1](https://github.com/primer/primer-primitives/pull/1) Add color, typography, and spacing packages. ([@broccolini](https://github.com/broccolini))
+* [#1](https://github.com/primer/primer-primitives/pull/1) Add primer-primitives package that imports all primitives. ([@broccolini](https://github.com/broccolini))

README.md

@@ -1,22 +1,13 @@
 # Primer Primitives
 
-This is a monorepo for color, spacing, and typography primitives for use with [Primer][primer], GitHub's design system.
-
-## Packages
-
-The Primer Primitives repo is a monorepo composed of multiple npm packages:
-
-- [primer-primitives][primer-primitives]
-- [primer-colors][primer-colors]
-- [primer-spacing][primer-spacing]
-- [primer-typography][primer-typography]
+This repo contains values for color, spacing, and typography primitives for use with [Primer][primer], GitHub's design system.
 
 ## Install
 
-This repository is distributed with [npm][npm]. After [installing npm][install-npm], you can install `primer-primitives` with this command.
+This repository is distributed with [npm][npm]. After [installing npm][install-npm], you can install `@primer/primitives` with this command.
 
 ```sh
-$ npm install --save primer-primitives
+$ npm install --save @primer/primitives
 ```
 
 ## Usage
@@ -25,14 +16,23 @@ JSON is a highly interoperable format that can be used in many types of projects
 
 ### Example
 
-This shows an example for a React.js project. You can import Primer Primitives to provide theme values to a `ThemeProvider`. This is a great way of sharing system styles and can be achieved with popular CSS-in-JS libraries such as [styled-components](https://www.styled-components.com/) and [emotion](https://emotion.sh/).
+The Primer Primitives are exported as keys on the top-level export, or can be imported individually.
+
+```js
+import { colors, typography } from '@primer/primitives'
+// or
+import colors from '@priler/primitives/colors'
+import typography from '@priler/primitives/typography'
+```
+
+In addition, Primer Primitives exports a `theme`, which is a great way of sharing system styles and works with popular CSS-in-JS libraries such as  [styled-components](https://www.styled-components.com/) and [emotion](https://emotion.sh/).
 
 Here's an example using `styled-components`.
 
 ```js
 import React from 'react'
 import styled, { ThemeProvider } from 'styled-components'
-import theme from 'primer-primitives'
+import { theme } from '@primer/primitives'
 
 const Alert = styled.div`
   color: ${props => props.theme.colors.green[9]};
@@ -52,7 +52,7 @@ When used with libraries like [styled-system](https://jxnblk.com/styled-system/)
 ```js
 import React from 'react'
 import styled, { ThemeProvider } from 'styled-components'
-import theme from 'primer-primitives'
+import { theme } from '@primer/primitives'
 import { color } from 'styled-system'
 
 const Alert = styled.div`
@@ -67,14 +67,18 @@ const App = props => (
 
 ```
 
+You can also import the `colors`, `typography`, and `spacing` primitives individually if you so desire:
+
+```js
+import colors from '@primer/primitives/colors'
+import spacing from '@primer/primitives/spacing'
+import typography from '@primer/primitives/typography'
+```
+
 ## License
 
 [MIT](./LICENSE) © [GitHub](https://github.com/)
 
 [primer]: https://github.com/primer/primer
-[primer-primitives]: https://github.com/primer/primer-primitives/tree/master/modules/primer-primitives
-[primer-colors]: https://github.com/primer/primer-primitives/tree/master/modules/primer-colors
-[primer-spacing]: https://github.com/primer/primer-primitives/tree/master/modules/primer-spacing
-[primer-typography]: https://github.com/primer/primer-primitives/tree/master/modules/primer-typography
 [npm]: https://www.npmjs.com/
 [install-npm]: https://docs.npmjs.com/getting-started/installing-node

index.js

@@ -0,0 +1,12 @@
+const colors = require('./colors')
+const spacing = require('./spacing')
+const typography = require('./typography')
+const theme = require('./theme')
+
+module.exports = {
+  theme,
+
+  colors,
+  spacing,
+  typography
+}

package.json

@@ -1,6 +1,21 @@
 {
-  "private": true,
-  "devDependencies": {
-    "lerna": "^2.10.2"
-  }
+  "name": "@primer/primitives",
+  "version": "2.0.0",
+  "description": "Typography, spacing, and color primitives for Primer design system",
+  "main": "index.js",
+  "repository": "https://github.com/primer/primitives",
+  "keywords": [
+    "primitives",
+    "colors",
+    "spacing",
+    "typography",
+    "variables",
+    "design-system"
+  ],
+  "author": "GitHub, Inc.",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/primer/primer-primitives/issues"
+  },
+  "homepage": "https://github.com/primer/primer-primitives#readme"
 }

theme/index.js

@@ -0,0 +1,12 @@
+const colors = require('../colors')
+const space = require('../spacing')
+const { fontSizes, lineHeights } = require('../typography')
+
+const theme = {
+  colors,
+  space,
+  fontSizes,
+  lineHeights
+}
+
+module.exports = theme