Skip to content
This repository has been archived by the owner on Sep 19, 2024. It is now read-only.

Commit

Permalink
update readme with engineering section (#9)
Browse files Browse the repository at this point in the history
* update readme with engineering section

* update fallback fonts
  • Loading branch information
sergeyd-virtru authored Mar 19, 2019
1 parent 05b5922 commit 3e0f93a
Showing 1 changed file with 34 additions and 3 deletions.
37 changes: 34 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,41 @@ As of 2018, undocumented and thus, inconsistent.
1. Deactivate any fonts in this repo above in [Adobe Fonts](https://fonts.adobe.com/my_fonts).

# Intro for Engineers
## Installation
This repo is ready for installation as npm package:
```
npm install --save git+ssh://git@github.com/virtru/virtru-typography.git
```

Once it's installed, add this to your application:
```js
require('virtru-typography');
```

This assumes that you're using webpack with relevant loaders for css and font files.
Feel free to use dashboard and dashboard-v2 commits as a reference for adding `virtru-typography` to the existing projects:
https://github.com/virtru/dashboard/pull/649/files
https://github.com/virtru/dashboard-v2/pull/542/files

### Usage
This repo ships css files with `@font-face` directives as well as `woff`, `woff2`, `ttf` fonts right into your project.
To use fonts in your app you just need to specify relevant font in your css:
```css
.text {
font: 300 16px 'Open Sans', Helvetica, Arial, sans-serif;
}
```

```css
.text {
font-style: italic;
font-family: 'Raleway', Helvetica, Arial, sans-serif;
}
```

### Possible problems
- If your fonts don't load from CDN, check out this dashboard fix: https://github.com/virtru/dashboard/pull/665

TBD by engineering

## Install & Build

# Governance

Expand Down

0 comments on commit 3e0f93a

Please sign in to comment.