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 | [![CircleCI](https://circleci.com/gh/moonwalker/skylab.svg?style=svg&circle-token=74dd04c5b61630a32df1a0a84c38f25ccf517d99)](https://circleci.com/gh/moonwalker/skylab)
|
9 | [![renovatebot](https://badges.renovateapi.com/github/moonwalker/skylab)](https://renovatebot.com/dashboard#github/moonwalker/skylab)
|
10 | [![relative-ci](https://img.shields.io/badge/RelativeCI-enabled-brightgreen.svg)](https://app.relative-ci.com/projects/zY8z3pNyxBpiK0z9Khhi)
|
11 |
|
12 |
|
13 | ## Instalation
|
14 |
|
15 | ```shell
|
16 | yarn add @moonwalker/skylab
|
17 | ```
|
18 |
|
19 | ## Usage
|
20 |
|
21 | ```js
|
22 | import { Component } from '@moonwalker/skylab';
|
23 |
|
24 | const CustomComponent = props => (
|
25 | <div>
|
26 | <Component {...props} />
|
27 | </div>
|
28 | );
|
29 | ```
|
30 |
|
31 | ## Development
|
32 |
|
33 | Start development environment on `http://localhost:8080`
|
34 |
|
35 | ```shell
|
36 | yarn start
|
37 | ```
|
38 |
|
39 | ## Publishing
|
40 |
|
41 | ```shell
|
42 | yarn bump
|
43 | ```
|
44 |
|
45 | Will increase the version based on the recommended number provided by [conventional-changelog](https://github.com/release-it/conventional-changelog) plugin.
|
46 |
|
47 | ### Pre-releases
|
48 |
|
49 | When publishing from a branch, the default behaviour is to publish a `beta` tag
|