Skip to content

Commit

Permalink
UPDATE: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
MatteuSan committed Feb 24, 2024
1 parent 65755ac commit 21fea92
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions packages/himig/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,16 @@
![Gaia Logo Light Mode](https://raw.githubusercontent.com/GrowStocks/gaia/main/media/gds-logo-light.svg?sanitize=true#gh-light-mode-only)
![Gaia Logo Dark Mode](https://raw.githubusercontent.com/GrowStocks/gaia/main/media/gds-logo-dark.svg?sanitize=true#gh-dark-mode-only)

## Prerequisites
Be sure to have [NodeJS](https://nodejs.org) LTS installed. Any other version will risk the project breaking in
development.
This design system is dependent on the CSS preprocessor, [Sass](https://sass-lang.com). When using sass, **be sure to
This design system is dependent on the CSS preprocessor, [Sass](https://sass-lang.com). When using Sass, **be sure to
use DartSass instead of the now deprecated LibSass (node-sass)**.

## Setup
```sh
$ npm install @growstocks/himig --save
$ npm install @matteusan/himig --save

# or

$ yarn add @growstocks/himig
$ yarn add @matteusan/himig
```
```scss
// main.scss
Expand All @@ -25,5 +22,6 @@ $ yarn add @growstocks/himig
@include ms-button.render();
}
```

## Contributing
Contributing guidelines are located [here](https://github.com/GrowStocks/gaia/tree/main/.github/CONTRIBUTING.md).
Contributing guidelines are located [here](https://github.com/MatteuSan/himig/tree/main/.github/CONTRIBUTING.md).

0 comments on commit 21fea92

Please sign in to comment.