Skip to content
Snippets Groups Projects
Commit 3369c59f authored by Ken Hawkins's avatar Ken Hawkins
Browse files

optimisation: rename vf-core component to vf-componenet-rollup

Makes it more clear that this isn't vf-core's heart, but rather a rollup for css, js
parent b949cd00
No related branches found
No related tags found
No related merge requests found
......@@ -5,7 +5,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
## 0.0.9 (2019-03-28)
**Note:** Version bump only for package @visual-framework/vf-core
**Note:** Version bump only for package @visual-framework/vf-componenet-rollup
......@@ -13,7 +13,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
## 0.0.8 (2019-02-28)
**Note:** Version bump only for package @visual-framework/vf-core
**Note:** Version bump only for package @visual-framework/vf-componenet-rollup
......@@ -21,7 +21,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
## 0.0.7 (2019-02-28)
**Note:** Version bump only for package @visual-framework/vf-core
**Note:** Version bump only for package @visual-framework/vf-componenet-rollup
......
# vf-core Component
# vf-componenet-rollup Component
[![npm version](https://badge.fury.io/js/%40visual-framework%2Fvf-core.svg)](https://badge.fury.io/js/%40visual-framework%2Fvf-core)
[![npm version](https://badge.fury.io/js/%40visual-framework%2Fvf-componenet-rollup.svg)](https://badge.fury.io/js/%40visual-framework%2Fvf-componenet-rollup)
The `vf-core` compiles all the components Sass into a style.css file.
The `vf-componenet-rollup` compiles component Sass and JS into style.css and scripts.js files, retrospectively.
## Install
This repository is distributed with [npm][npm]. After [installing npm][install-npm], you can install `primer-buttons` with this command.
This repository is distributed with [npm][npm]. After [installing npm][install-npm], you can install `vf-componenet-rollup` with this command.
```
$ npm install --save @visual-framework/vf-core
$ npm install --save @visual-framework/vf-componenet-rollup
```
## Usage
......@@ -17,7 +17,7 @@ $ npm install --save @visual-framework/vf-core
The source files included are written in [Sass][sass] (`scss`) You can simply point your sass `include-path` at your `node_modules` directory and import it like this.
```
@import "@visual-framework/vf-core/index.scss";
@import "@visual-framework/vf-componenet-rollup/index.scss";
```
_Make sure you import any requirements along with the modules._
{
"version": "0.0.9",
"name": "@visual-framework/vf-core",
"description": "vf-core component",
"name": "@visual-framework/vf-componenet-rollup",
"description": "vf-componenet-rollup component",
"homepage": "https://visual-framework.github.io/vf-core",
"author": "VF",
"license": "Apache 2.0",
"style": "vf-core.css",
"style": "vf-componenet-rollup.css",
"sass": "index.scss",
"main": "build/index.js",
"files": [
"index.scss",
"vf-core.scss",
"vf-core.css",
"vf-core.njk",
"vf-core.config.yml"
"scripts.js",
"README.md"
"vf-componenet-rollup.css"
],
"test": "echo \"Error: no test specified\" && exit 1",
"publishConfig": {
"access": "public"
},
"repo": "https://github.com/visual-framework/vf-core/tree/master/tree/master/components/vf-core",
"repo": "https://github.com/visual-framework/vf-core/tree/master/tree/master/components/vf-componenet-rollup",
"bugs": {
"url": "https://github.com/visual-framework/vf-core/issues"
},
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment