Skip to content

Commit

Permalink
docs: 📝 add install guide to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
VoloshchenkoAl committed Jun 10, 2022
1 parent 68fa3e4 commit b17f46a
Showing 1 changed file with 26 additions and 12 deletions.
38 changes: 26 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,44 @@
# macpaw-ui

## Installation

Install with npm:

```bash
npm install --save @macpaw/macpaw-ui
```

or with yarn:

```bash
yarn add @macpaw/macpaw-ui
```

## Adding new Component

* Add Component's JSX and styles to [src/%ComponentName%](/src) directory
* Import Component's JS, styles to [ui.js](/src/ui.js) and [ui.scss](/src/ui.scss) correspondingly
* Add document page in `/pages/%component-name%.mdx`
- Add Component's JSX and styles to [src/%ComponentName%](/src) directory
- Import Component's JS, styles to [ui.js](/src/ui.js) and [ui.scss](/src/ui.scss) correspondingly
- Add document page in `/pages/%component-name%.mdx`

## Adding new Icons

* All common icons should have size 24x24px and dynamic (not hard-coded) `fill` attribute (so it can be changed / overridden later is CSS or React component)
* Add new SVG file icon to `src/Icons/svg/%name%_icon.svg`
* Run `yarn icons` CLI command
- All common icons should have size 24x24px and dynamic (not hard-coded) `fill` attribute (so it can be changed / overridden later is CSS or React component)
- Add new SVG file icon to `src/Icons/svg/%name%_icon.svg`
- Run `yarn icons` CLI command

## Requirements

* Node 16+
* npm 7+ (lock file v2)
- Node 16+
- npm 7+ (lock file v2)

## Release

Package published with Github Actions:

* Update version in [package.json](package.json) file
* Create new release at Github
- Update version in [package.json](package.json) file
- Create new release at Github

## Host

* run `yarn build`
* serve `out` directory as public
- run `yarn build`
- serve `out` directory as public

0 comments on commit b17f46a

Please sign in to comment.