@otovo/rainbow - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

package.json

 {
   "name": "@otovo/rainbow",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Design system for Otovo",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -1,3 +0,81 @@
-# Rainbow
+# 🌈 Rainbow
 
-A design system made for Otovo
+> Otovo's Design System
+
+## Getting started
+
+1. Install Rainbow and its peer dependencies
+
+```sh
+yarn add @otovo/rainbow @emotion/core @emotion/styled emotion-theming styled-system
+```
+
+2. Add the Rainbow theme your `app.js`
+
+```jsx
+import { ThemeProvider } from 'emotion-theming';
+import { theme } from '@otovo/rainbow';
+
+class App extends Component {
+  render() {
+    return (
+      <ThemeProvider theme={theme}>
+        <Page />
+      </ThemeProvider>
+    );
+  }
+}
+```
+
+3. Go to town
+
+```jsx
+import { H2, BodyM, CORE, BORDER } from '@otovo/rainbow';
+import styled from '@emotion/styled';
+
+const CustomCard = styled.div`
+  ${CORE}
+  ${BORDER}
+`;
+
+export default () => (
+  <CustomCard bg="green.10" p="4" mb="3" borderRadius="2">
+    <H2 color="green.4">Welcome...</H2>
+    <BodyM color="green.2">to Zombo.com</BodyM>
+  </CustomCard>
+);
+```
+
+![The result](https://user-images.githubusercontent.com/3471625/58833035-7d58fb80-8650-11e9-9c99-f444ab76aad0.png)
+
+## Development 👩🏼‍💻
+
+Before you start making changes to `rainbow`, you should set up a link to [rainbow-documentation](https://github.com/otovo/rainbow-documentation). This will make it **a lot** easier to test your changes. Linking the repo can be done as follows (assuming you have placed the repos in `~/projects`):
+
+```sh
+cd ~/projects/rainbow
+yarn link
+
+cd ~/projects/rainbow-documentation
+yarn link @otovo/rainbow
+```
+
+Great! You're almost set. To rebuild the distribution whenever you change something, run...
+
+```
+yarn dev
+```
+
+_**Psst!** Remember to update the `rainbow-documentation` whenever you make changes to `rainbow`_ 🤓
+
+## Publishing 📦
+
+To release a new version to NPM, run...
+
+```
+yarn run release
+```
+
+The script will hold your hand through the rest of the process. Remember to use [semantic versioning](https://semver.org/).
+
+![Rainbows everywhere](https://media.giphy.com/media/Cx7yNo5TsPQru/giphy.gif)

No alert changes

Improved metrics

Total package byte prevSize

77539

increased by2.48%

Number of lines in readme file

82

increased by2633.33%

No dependency changes