-
Notifications
You must be signed in to change notification settings - Fork 219
/
Copy pathREADME.hbs
39 lines (27 loc) · 928 Bytes
/
README.hbs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# CircleType
[](https://travis-ci.org/peterhry/CircleType)
A JavaScript library that lets you curve type on the web.
Demo: <https://circletype.labwire.ca>
## Installation
In a browser:
```html
<script src="circletype.min.js"></script>
```
Using npm:
```shell
$ npm i circletype --save
```
Load ES module:
```js
import CircleType from `circletype`;
```
# API
{{>main}}
## Development Commands
| Command | Description |
|:------------------------|:----------------------------------|
| `npm run dev` | Start dev server |
| `npm start` | Build for release |
| `npm test` | Run unit and screenshot tests |
| `npm run docs` | Generate documentation |
| `npm run reference` | Generate reference screenshots |