Readme Update For

- hextorgb - hextorgba - pxtoem - pxtorem
heyjul3s · Feb 15, 2021 · 158d4cf · 158d4cf
1 parent 18c8469
commit 158d4cf
Show file tree

Hide file tree

Showing 4 changed files with 105 additions and 8 deletions.
diff --git a/packages/hextorgb/README.md b/packages/hextorgb/README.md
@@ -1,3 +1,31 @@
 # `@artifak/hextorgb`
 
 A utility function to convert hexadecimal colour values to RGB string.
+
+## Installation
+
+### Yarn
+
+```sh
+yarn add @artifak/hextorgb
+```
+
+### NPM
+
+```sh
+npm install @artifak/hextorgb
+```
+
+## Usage
+
+```ts
+import { hexToRGB } from 'artifak';
+import styled from 'styled-components';
+
+export const Container = styled.div`
+  margin: 0 auto;
+  width: 100%;
+  background: #000;
+  color: ${hexToRGB('#FFF')};
+`;
+```
diff --git a/packages/hextorgba/README.md b/packages/hextorgba/README.md
@@ -1,3 +1,31 @@
 # `@artifak/hextorgba`
 
 A utility function to convert hexadecimal colour values to RGBA string.
+
+## Installation
+
+### Yarn
+
+```sh
+yarn add @artifak/hextorgb
+```
+
+### NPM
+
+```sh
+npm install @artifak/hextorgb
+```
+
+## Usage
+
+```ts
+import { hexToRGBA } from 'artifak';
+import styled from 'styled-components';
+
+export const Container = styled.div`
+  margin: 0 auto;
+  width: 100%;
+  background: #000;
+  color: ${hexToRGBA('#FFF', 0.75)};
+`;
+```
diff --git a/packages/pxtoem/README.md b/packages/pxtoem/README.md
@@ -1,11 +1,32 @@
 # `@artifak/pxtoem`
 
-> TODO: description
+A utility function to convert px values to em.
 
-## Usage
+## Installation
+
+### Yarn
+
+```sh
+yarn add @artifak/pxtoem
+```
 
+### NPM
+
+```sh
+npm install @artifak/pxtoem
 ```
-const pxtoem = require('@artifak/pxtoem');
 
-// TODO: DEMONSTRATE API
+## Usage
+
+```ts
+import { pxToEm } from 'artifak';
+import styled from 'styled-components';
+
+export const Container = styled.div`
+  margin: 0 auto;
+  width: 100%;
+  background: #000;
+  padding-left: ${pxToEm('16px')};
+  padding-right: ${pxToEm('16px')};
+`;
 ```
diff --git a/packages/pxtorem/README.md b/packages/pxtorem/README.md
@@ -1,11 +1,31 @@
 # `@artifak/pxtorem`
 
-> TODO: description
+A utility function to convert px values to rem.
 
-## Usage
+## Installation
+
+### Yarn
+
+```sh
+yarn add @artifak/pxtorem
+```
 
+### NPM
+
+```sh
+npm install @artifak/pxtorem
 ```
-const pxtorem = require('@artifak/pxtorem');
 
-// TODO: DEMONSTRATE API
+## Usage
+
+```ts
+import { pxToRem } from 'artifak';
+import styled from 'styled-components';
+
+export const Container = styled.div`
+  margin: 0 auto;
+  width: 100%;
+  background: #000;
+  font-size: ${pxToRem('48px')};
+`;
 ```