From 01cc681cf2a84975256de89db76aa168782a9087 Mon Sep 17 00:00:00 2001 From: Stefano Pigozzi Date: Sat, 28 Aug 2021 12:49:01 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=97=92=20Add=20a=20README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 38 ++++++++++++++++++++++++++++++++++---- 1 file changed, 34 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6ca5c7d..0546546 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,40 @@ An interactive documentation for `bluelib-react` is available [here](http://gh.s ## Installation - -This package hasn't been published on npm yet. +You can download `bluelib-react` using your favourite node package manager: + +```console +$ npm install --save @steffo/bluelib-react +``` + +```console +$ yarn add @steffo/bluelib-react +``` + +Ensure you have `react` and `react-dom` installed, as they are peer dependencies of this package and aren't installed automatically. ## Usage - -The guide for the usage of this package hasn't been written yet. +You can import the components you want to use using the ES6 import syntax: + +```js +import { Box } from "@steffo/bluelib-react" +``` + +**All** Bluelib components must be **inside a `` container** for them to work correctly! + +```jsx +import { Bluelib, Heading, Box } from "@steffo/bluelib-react" + + +const MyComponent = props => ( + + + Hello world! + + + Welcome to Bluelib! + + +) +``` \ No newline at end of file