Skip to content

Commit 251c279

Browse files
author
doripjonov
committed
changed docs
1 parent 3fd1e53 commit 251c279

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ CompreFace JavaScript SDK makes face recognition into your application even easi
99
- [Initialization](#initialization)
1010
- [Adding faces into a face collection](#adding-faces-into-a-face-collection)
1111
- [Recognition](#recognition)
12+
- [Enviroments](#enviroments)
13+
- [Webcam demo](#webcam-demo)
1214
- [Reference](#reference)
1315
- [CompreFace Global Object](#compreface-global-object)
1416
- [Recognition Service](#recognition-service)
@@ -102,6 +104,30 @@ recognitionService.recognize(path_to_image)
102104
})
103105
```
104106

107+
### Enviroments
108+
NOTE: We provide 3 ways of uploading image to our SDK. They are url, blob and relative path (from local machine).
109+
110+
| Enviroments | from URL | with Blob format | from local machine|
111+
| ------------|--------- | ---------------- | ---------------- |
112+
| Browser ||||
113+
| Nodejs ||||
114+
115+
### Webcam demo
116+
117+
In this part of docs we show how to use our detection service with webcamera. NOTE: we have chosen reactjs as it is today's one of the most popular UI library.
118+
119+
1 Install reactjs
120+
121+
```npx create-react-app compreface-demo```
122+
123+
2 Enter to project folder
124+
125+
```cd compreface-demo```
126+
127+
3 Install CompreFace SDK
128+
129+
```npm i @exadel/compreface-js-sdk```
130+
105131
## Reference
106132

107133
### CompreFace Global Object

0 commit comments

Comments
 (0)