Skip to content

Commit

Permalink
readme: Remove outdated partials and installation
Browse files Browse the repository at this point in the history
  • Loading branch information
seejamescode authored Nov 29, 2017
1 parent db1c330 commit 758fc43
Showing 1 changed file with 2 additions and 9 deletions.
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,22 +23,15 @@ The IBM Type code provides rendering and kerning that best reflects IBM Plex. Th

## How to Use

At the moment, installation requires [Node.js and npm](https://docs.npmjs.com/getting-started/installing-node). This will change by v1.0.0 when a CDN become available.

To install, run `npm install @ibm/type`

If you want to use the compiled css, reference the file in the dist folder:
```
<link rel="stylesheet" type="text/css" href="node_modules/@ibm/type/dist/css/ibm-type.min.css">
```

If you want to use the sass partials, import the files in the src folder:
```
@import 'node_modules/@ibm/type/src/_core.scss';
@import 'node_modules/@ibm/type/src/_styles.scss';
@import 'node_modules/@ibm/type/src/_width.scss';
```

Check out the Performance section below for a description of each partial.

## Classname Reference

| Classname | Purpose |
Expand Down

0 comments on commit 758fc43

Please sign in to comment.