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.

Sign up for GitHub

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

40 remove build files from git #44

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

40 remove build files from git #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
908bfbf
Removed dist/ from source control
renatodeleao Nov 29, 2019
e4323ae
Update readme with some badges swag
renatodeleao Nov 29, 2019
a3c5677
Uppdated editorconfig
renatodeleao Nov 29, 2019
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
14 changes: 3 additions & 11 deletions .editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ root = true

# Unix-style newlines with a newline ending every file
[*]
indent_style = tab
indent_style = space
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline = true
Expand All @@ -19,23 +19,15 @@ trim_trailing_whitespace = false
charset = utf-8

[*.{scss,css,sass}]
indent_style = space
indent_size = 2

[*.{html,hbs,erb,haml}]
indent_style = space
indent_size = 3
indent_size = 2

[*.{json,yml}]
indent_style = space
indent_size = 2

# 4 space indentation
# [*.py]
# indent_style = space
# indent_size = 4
#
# # Tab indentation (no size specified)

# [Makefile]
# indent_style = tab
#
Expand Down
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,4 @@ yarn-error*
.cache/
public/
docs/
dist/
32 changes: 30 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@

<h1 align="center">
qnorr
</h1>

<p align="center">
A style agnostic sass seasoning framework to bootstrap your projects
<br />
<br />

<a href="https://www.npmjs.com/package/@whitesmith/qnorr-styles">
<img src="https://img.shields.io/npm/v/@whitesmith/qnorr-styles?color=%23ffbc05&logo=asdad&style=for-the-badge" alt="npm version">
</a>

<img src="https://img.shields.io/github/license/whitesmith/qnorr-styles?style=for-the-badge" alt="license">

</p>

---

## Documentation

> If it’s not documented, it doesn’t exist. Documentation should become the default – an integrated part of the development process.
Expand All @@ -12,10 +32,18 @@ Install via `npm` or `yarn`.
yarn add @whitesmith/qnorr-styles
```

Alternatively you can add the built version straight into you pages head

```html
<!-- replace x.x.x per your current version -->
<link rel="stylesheet" href="https://unpkg.com/@whitesmith/[email protected]/dist/qnorr.min.css">
```


## usage
If you've installed the package as module then **at your `{main,index,app}.scss`**


**at your `{main,index,app}.scss`**
```scss
@import "path/to/node_modules/@whitesmith/qnorr-styles/scss/qnorr";

Expand Down Expand Up @@ -116,4 +144,4 @@ yarn run playground:dev
```

## License
[MIT](LICENSE) — made with 💚 by [Whitesmith](https://whitesmith.co).
[MIT](LICENSE) — made with 💚 by [Whitesmith](https://whitesmith.co).
Loading