1 | <p align="center"><img width="640" src="https://www.researchgate.net/profile/Alice_Gorman/publication/241728431/figure/fig1/AS:298606130155526@1448204657773/Schematic-of-Skylab-Image-courtesy-of-NASA.png"/></p>
|
2 |
|
3 | # Skylab
|
4 |
|
5 | *Simple* project specific React components.
|
6 |
|
7 | [![npmjs](https://img.shields.io/npm/v/@moonwalker/skylab.svg)](https://www.npmjs.com/package/@moonwalker/skylab)
|
8 | ![ci](https://github.com/moonwalker/skylab/workflows/ci/badge.svg)
|
9 | [![renovatebot](https://badges.renovateapi.com/github/moonwalker/skylab)](https://renovatebot.com/dashboard#github/moonwalker/skylab)
|
10 | [![relativeCI](https://badges.relative-ci.com/badges/zY8z3pNyxBpiK0z9Khhi?branch=master)](https://app.relative-ci.com/projects/zY8z3pNyxBpiK0z9Khhi)
|
11 | [![](https://raw.githubusercontent.com/storybookjs/brand/master/badge/badge-storybook.svg?sanitize=true)](https://storybook.dreamz.com/skylab/storybook/master.html)
|
12 |
|
13 |
|
14 | ## Instalation
|
15 |
|
16 | ```shell
|
17 | yarn add @moonwalker/skylab
|
18 | ```
|
19 |
|
20 | ## Usage
|
21 |
|
22 | ```js
|
23 | import { Component } from '@moonwalker/skylab';
|
24 |
|
25 | const CustomComponent = props => (
|
26 | <div>
|
27 | <Component {...props} />
|
28 | </div>
|
29 | );
|
30 | ```
|
31 |
|
32 | ## Development
|
33 |
|
34 | Start development environment on `http://localhost:8080`
|
35 |
|
36 | ```shell
|
37 | yarn start
|
38 | ```
|
39 |
|
40 | ## Publishing
|
41 |
|
42 | ```shell
|
43 | yarn bump
|
44 | ```
|
45 |
|
46 | Will increase the version based on the recommended number provided by [conventional-changelog](https://github.com/release-it/conventional-changelog) plugin.
|
47 |
|
48 | ### Pre-releases
|
49 |
|
50 | When publishing from a branch, the default behaviour is to publish a `beta` tag
|