Skip to content

Commit

Permalink
1
Browse files Browse the repository at this point in the history
  • Loading branch information
liorocks committed Sep 10, 2015
1 parent a73b688 commit 0b9be17
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 94 deletions.
89 changes: 17 additions & 72 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,105 +1,50 @@
# BPG Algeti

![Bower](https://img.shields.io/bower/v/bpg-algeti.svg)
![Bower](https://img.shields.io/bower/l/bpg-algeti.svg)
![Author](https://img.shields.io/badge/Font_Author-Besarion_Gugushvili-blue.svg)
![IE](https://img.shields.io/badge/IE_Support-6+-brightgreen.svg)
![Files](https://img.shields.io/badge/Font_Files-.ttf,_.eot,_.svg,_.woff,_.woff2-brightgreen.svg)
[![Bower](https://img.shields.io/bower/v/bpg-algeti.svg)](http://bower.io/search/?q=bpg-algeti)
[![npm](https://img.shields.io/npm/v/bpg-algeti.svg)](https://www.npmjs.com/package/bpg-algeti)
[![Author](https://img.shields.io/badge/Font_Author-Besarion_Gugushvili-blue.svg)](https://github.com/web-fonts/bpg-algeti)

BPG Algeti Web Font Package.
BPG Algeti Web-Font Package.

## Installation

Run the following command to install the font with [Bower](http://bower.io) (recommended):
### Install With [Bower](http://bower.io):

```
$ bower install bpg-algeti --save
```

Or install it manually, by [downloading the archive](https://github.com/web-fonts/bpg-algeti/archive/master.zip) and placeing `/css/` and `/fonts/` directories to your project.
### Install With [NPM](https://www.npmjs.com):

## Usage

BPG Algeti web font package comes with 3 different css files:

* [bpg-algeti.css](https://github.com/web-fonts/bpg-algeti/tree/master/css/bpg-algeti.css) - Modern way of including web fonts on web page, which contains only: `.woff` and `.woff2` files (see the browser support below).
* [bpg-algeti.ie.css](https://github.com/web-fonts/bpg-algeti/tree/master/css/bpg-algeti.ie.css) - IE6-8, which contains: `.eot` font file only.
* [bpg-algeti.legacy.css](https://github.com/web-fonts/bpg-algeti/tree/master/css/bpg-algeti.legacy.css) - [Bulletproof @font-face syntax](http://www.paulirish.com/2009/bulletproof-font-face-implementation-syntax/), which contains: `.eot`, `.ttf`, `.svg`, `.woff` and `.woff2` files.

### Modern Syntax (Recommended)

```html
<link rel="stylesheet" href="/bower_components/bpg-algeti/css/bpg-algeti.css">
```

### IE Syntax (Optional)

Optional support for IE 8 or below.

```html
<!--[if lt IE 9]>
<link rel="stylesheet" href="/bower_components/bpg-algeti/css/bpg-algeti.ie.css">
<![endif]-->
$ npm install bpg-algeti --save
```

### Bulletproof Syntax (Old Way)

Or if you prefer [Bulletproof @font-face syntax](http://www.paulirish.com/2009/bulletproof-font-face-implementation-syntax/), include the following css.
### Install Manualy

```html
<link rel="stylesheet" href="/bower_components/bpg-algeti/css/bpg-algeti.legacy.css">
```
* [Downloading Package Archive](https://github.com/web-fonts/bpg-algeti/archive/master.zip)
* Place `/css/` and `/fonts/` directories to your project.

### Minified
## Usage

All those 3 css files have minified versions with suffix: `.min`. Example:
Place the following code between `<head>...</head>` tag in your HTML:

```html
<link rel="stylesheet" href="/bower_components/bpg-algeti/css/bpg-algeti.min.css">
<link rel="stylesheet" href="/bower_components/bpg-algeti/css/bpg-algeti.css">
```

### Final Step

Finally, after including font files to your project, place the following code to your stylesheets, or use another css selector instead of `body`.
Place the following code to your stylesheets, or use another css selector instead of `body`.

```css
body {
font-family: 'BPG Algeti', sans-serif;
}
```

## Browser Support

**Modern Syntax**, which contains only: `.woff` and `.woff2` files is supported in the following browsers:
## Preview

| Chrome | Safari | Firefox | Opera | IE | Android | iOS |
| ------ | ------ | ------- | ----- | ---- | ------- | ----- |
| 5+ | 5.1+ | 3.6+ | 11.5+ | 9+ | 4.4+ | 5.1+ |

**IE Syntax** supports only IE6-8.

**Bulletproof Syntax** supports every major browser and it's versions, including IE6-8.
[Preview BPG Algeti in Browser](http://web-fonts.ge/bpg-algeti)

## Licence

The MIT License (MIT)

Copyright (c) 2015 Lado Lomidze.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
The BPG Algeti package is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT), but the Font files are licenced under [CC BY-NC-ND 4.0](http://creativecommons.org/licenses/by-nc-nd/4.0/).
5 changes: 3 additions & 2 deletions bower.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "bpg-algeti",
"description": "BPG Algeti Web Font",
"description": "BPG Algeti Web-Font Package",
"version": "1.0.0",
"keywords": ["ttf", "woff", "woff2", "svg", "font", "web-font", "bpg-algeti"],
"main": [
"css/bpg-algeti.css"
Expand All @@ -13,7 +14,7 @@
"type": "git",
"url": "https://github.com/web-fonts/bpg-algeti.git"
},
"license": "MIT",
"license": ["MIT", "CC-BY-NC-ND-4.0"],
"ignore": [
"**/.*",
"node_modules",
Expand Down
8 changes: 6 additions & 2 deletions css/bpg-algeti.css
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
@font-face {
font-family: 'BPG Algeti';
src: url('../fonts/bpg-algeti-webfont.woff2') format('woff2'),
url('../fonts/bpg-algeti-webfont.woff') format('woff');
src: url('../fonts/bpg-algeti-webfont.eot'); /* IE9 Compat Modes */
src: url('../fonts/bpg-algeti-webfont.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */
url('../fonts/bpg-algeti-webfont.woff2') format('woff2'), /* Super Modern Browsers */
url('../fonts/bpg-algeti-webfont.woff') format('woff'), /* Pretty Modern Browsers */
url('../fonts/bpg-algeti-webfont.ttf') format('truetype'), /* Safari, Android, iOS */
url('../fonts/bpg-algeti-webfont.svg#bpg_algetiregular') format('svg'); /* Legacy iOS */
}
5 changes: 0 additions & 5 deletions css/bpg-algeti.ie.css

This file was deleted.

1 change: 0 additions & 1 deletion css/bpg-algeti.ie.min.css

This file was deleted.

9 changes: 0 additions & 9 deletions css/bpg-algeti.legacy.css

This file was deleted.

1 change: 0 additions & 1 deletion css/bpg-algeti.legacy.min.css

This file was deleted.

2 changes: 1 addition & 1 deletion css/bpg-algeti.min.css

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

2 changes: 1 addition & 1 deletion font.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "BPG Algeti",
"author": "Besarion Gugushvili",
"version": "0.0.1"
"version": "1.0.0"
}

0 comments on commit 0b9be17

Please sign in to comment.