Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Formatted README #86

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 24 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,44 @@
# Ultimaker stylelint config

This package contains mostly sane linting rules for both CSS and SCSS files for
Ultimaker web-based projects.
# Ultimaker Stylelint Config

These linting rules are set up to allow the writing of consistent, readable, and
simple CSS or SCSS.
*Linting rules for both **CSS** and **SCSS** files of Ultimaker web-based projects.*

<br>

## Usage

To use these linting rules, create a file called `.stylelintrc.js` in the root
of your project.
Create a file called  `.stylelintrc.js`  in the root of your project.

<br>

To lint CSS files, add the following:
Add this to lint **CSS** files.

```javascript
module.exports = {
extends: "@ultimaker/stylelint-config"
extends : '@ultimaker/stylelint-config'
};
```

To lint SCSS files, add the following:
<br>

Add this to lint **SCSS** files.

```javascript
module.exports = {
extends: "@ultimaker/stylelint-config/scss"
extends : '@ultimaker/stylelint-config/scss'
};
```

<br>
<br>

## Publishing
Publishing works the same way as we have implemented in [stardust-web](https://github.com/Ultimaker/stardust-web/blob/master/docs/publishing.md).

Works the same way as we have implemented in **[Stardust-Web]**.


<br>

<!----------------------------------------------------------------------------->

[Stardust-Web]: https://github.com/Ultimaker/stardust-web/blob/master/docs/publishing.md