Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
basst314 committed Jan 14, 2018
2 parents 5f32686 + 0dec44a commit 8f00b2a
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,44 @@ If you're looking for a simple to use, minimized version of an Angular webcam-co

**Minimal.** No unnecessary Flash-fallbacks, no bundle-size bloating.

## Prerequisites
Runtime Dependencies:
* Angular 2.x, 4.x or 5.x
* RxJs (Observables, Subjects)

Client:
* Current Browser w/ HTML5 support (Chrome, Safari, Firefox, Edge, IE)
* Webcam :)
* User permissions to access the webcam

## Usage
1) Install the library via standard npm command:

`npm install --save ngx-webcam`

2) Import the `WebcamModule` into your Angular module:

```
import {WebcamModule} from 'ngx-webcam';
@NgModule({
imports: [
WebcamModule
...
],
...
})
export class AppModule { }
```

3) Use the `WebcamComponent` on your pages:

`<webcam></webcam>`

As simple as that.

## Options and Events
Find options and events here soon... // development in progress

## Development
Here you can find instructions on how to start developing this library.
Expand Down

0 comments on commit 8f00b2a

Please sign in to comment.