Skip to content

Commit 5bdbff3

Browse files
committed
Updated readme and gitignore
1 parent 0b82adc commit 5bdbff3

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

.gitignore

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
/dist
2-
node_modules/
2+
node_modules/
3+
4+
package-lock.json

Readme.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,18 @@
22

33
A javascript library for parsing and manipulation of SMPTE/EBU/Generic timecodes, framerates and framecounts.
44

5+
## Install
6+
7+
```shell
8+
npm install @wfoxall/timeframe
9+
```
10+
511
## Usage
612

713
### Timecode Class
814

915
```typescript
10-
import {Timecode} from '../';
16+
import {Timecode} from '@wfoxall/timeframe';
1117

1218
const tc1 = new Timecode('00:01:01:00',"29.97DF");
1319
console.log(tc1.toString());
@@ -35,7 +41,7 @@ console.log(tc1.toString());
3541
Framerate objects can be instantiated by passing a FramerateLike value. The resulting object can then be used to initialize a Timecode instance.
3642

3743
```typescript
38-
import {Framerate} from '../';
44+
import {Framerate} from '@wfoxall/timeframe';
3945

4046
let fr1 = new Framerate(29.97);
4147
console.log(fr1.toString());

0 commit comments

Comments
 (0)