Skip to content

Commit

Permalink
readme & docs v1.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
Black Mirror authored and Black Mirror committed Jun 29, 2018
1 parent ca8a524 commit e5e6141
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 87 deletions.
71 changes: 0 additions & 71 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,71 +0,0 @@
# flavor-scss

## Author
Black Mirror

## Version
v1.1.2

## Badges

[![NPM](https://nodei.co/npm/flavor-scss.png)](https://nodei.co/npm/flavor-scss/)

[![NPM downloads/month](https://img.shields.io/npm/dm/flavor-scss.svg)](hhttps://img.shields.io/npm/dm/flavor-scss.svg)

[![GitHub stars](https://img.shields.io/github/stars/blackmirror1980/flavor-scss.svg?style=plastic)](https://github.com/blackmirror1980/flavor-scss/stargazers) [![GitHub forks](https://img.shields.io/github/forks/blackmirror1980/flavor-scss.svg?style=plastic)](https://github.com/blackmirror1980/flavor-scss/network) [![GitHub issues](https://img.shields.io/github/issues/blackmirror1980/flavor-scss.svg?style=plastic)](https://github.com/blackmirror1980/flavor-scss/issues) [![GitHub license](https://img.shields.io/github/license/blackmirror1980/flavor-scss.svg?style=plastic)](https://github.com/blackmirror1980/flavor-scss/blob/master/LICENSE)

[![Build Status](https://travis-ci.org/blackmirror1980/flavor-scss.svg?branch=master)](https://travis-ci.org/blackmirror1980/flavor-scss) [![Coverage Status](https://coveralls.io/repos/github/blackmirror1980/flavor-scss/badge.svg?branch=master)](https://coveralls.io/github/blackmirror1980/flavor-scss?branch=master)

## Documentation
Check out the [Latest Documentation](https://blackmirror1980.github.io/flavor-scss/index.html) here

## Changelog
Check out the [Changelog](https://github.com/blackmirror1980/flavor-scss/blob/master/CHANGELOG.md)

## Description
Flavor SCSS - Advanced type checking Sass/SCSS Framework with Mixins & Helpers and a fully customizable Grid System

## Example
Check out this [Codepen]() example

## Installation

This is a [Node.js](https://nodejs.org/) module available through the
[npm registry](https://www.npmjs.com/). It can be installed using the
[`npm`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally)
or
[`yarn`](https://yarnpkg.com/en/)
command line tools.

```sh
npm install flavor-scss --save
```

## Dependencies

None

## Dev Dependencies

- [minimatch](https://ghub.io/minimatch): a glob matcher in javascript
- [pkg-2-readme](https://ghub.io/pkg-2-readme): Generate a README.md from package.json contents
- [sass-lint](https://ghub.io/sass-lint): All Node Sass linter!
- [sassdoc](https://ghub.io/sassdoc): Release the docs!
- [sassdoc-theme-flippant](https://ghub.io/sassdoc-theme-flippant): A modified version of Sassdoc's default theme

## Tests

```sh
npm install
npm test
```


## License

MIT

## Powered By
<a href="http://js.org" target="_blank" title="JS.ORG | JavaScript Community">
<img src="http://logo.js.org/dark_horz.png" width="102" alt="JS.ORG Logo"/></a>
<!-- alternatives [bright|dark]_[horz|vert|tiny].png (width[horz:102,vert:50,tiny:77]) -->
54 changes: 40 additions & 14 deletions docs/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@
"sassdoc": "^2.5.0",
"sassdoc-theme-flippant": "^0.1.0"
}
}
}

0 comments on commit e5e6141

Please sign in to comment.