Skip to content

Commit 34b2aa7

Browse files
committed
Included demo video link & snips in README & Updated version info
1 parent 1ddd96d commit 34b2aa7

File tree

4 files changed

+16
-20
lines changed

4 files changed

+16
-20
lines changed

README.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
<h1 align="center">Attendance System using Face Recognition</h1>
2-
<p>
3-
<a href="https://github.com/codeglitchz/attendance-system/releases/tag/v2.0.0" target="_blank">
4-
<img alt="Version" src="https://img.shields.io/badge/version-v2.0.0-blue.svg?cacheSeconds=2592000" />
5-
</a>
6-
<a href="https://github.com/codeglitchz/attendance-system/blob/master/LICENSE" target="_blank">
7-
<img alt="License: MIT" src="https://img.shields.io/github/license/codeglitchz/attendance-system" />
8-
</a>
9-
</p>
2+
3+
[![HitCount](http://hits.dwyl.com/codeglitchz/attendance-system.svg)](http://hits.dwyl.com/codeglitchz/attendance-system)
4+
<a href="https://github.com/codeglitchz/attendance-system/blob/master/LICENSE" target="_blank">
5+
<img alt="License: MIT" src="https://img.shields.io/github/license/codeglitchz/attendance-system" />
6+
</a>
7+
<a href="https://github.com/codeglitchz/attendance-system/releases/tag/v2.1.1" target="_blank">
8+
<img alt="Version" src="https://img.shields.io/badge/version-v2.1.1-blue.svg?cacheSeconds=2592000" />
9+
</a>
10+
1011

1112
> A simple, modern and scalable facial recognition based attendance system
1213
> built with Python back-end & Angular front-end.
1314
14-
![UI](sample/ui.gif)
15+
#####[Watch Demo Video](https://www.youtube.com/watch?v=9-7uR78ab5c)
1516

1617
## Table of contents
1718
* [Prerequisites](#prerequisites)
1819
* [Installation](#installation)
19-
1. [Clone repository](#1-clone-repository)
20-
2. [Setup backend](#2-setup-backend)
21-
3. [Setup frontend](#3-setup-frontend)
20+
1. [Setup backend](#1-setup-backend)
21+
2. [Setup frontend](#2-setup-frontend)
2222
* [Usage](#usage)\
2323
a. [Using CLI](#a-using-cli)\
2424
b. [Using Web Interface](#b-using-web-interface)
@@ -35,13 +35,7 @@
3535

3636
## Installation
3737

38-
#### 1. Clone repository
39-
For stable release, clone `master` branch
40-
```sh
41-
$ git clone -b master https://github.com/codeglitchz/attendance-system.git
42-
$ cd attendance-system
43-
```
44-
#### 2. Setup backend
38+
#### 1. Setup backend
4539

4640
Install all dependencies using conda package manager
4741
> Note: This will install the dependencies listed in `environments.yml` file
@@ -55,7 +49,7 @@ Now you can activate this environment using the following command
5549
$ conda activate attendance-system
5650
```
5751

58-
#### 3. Setup frontend
52+
#### 2. Setup frontend
5953
Install all dependencies using npm package manager
6054
> Note: This will install the dependencies listed in `package.json` file
6155
```sh
@@ -74,6 +68,7 @@ $ cd backend
7468
$ conda activate attendance-system
7569
$ python run_cli.py
7670
```
71+
![cli_snip](sample/cli_snip.JPG)
7772

7873
#### B. Using Web Interface
7974
Start the Flask Web Server
@@ -92,6 +87,7 @@ Launch the Angular Web Application
9287
$ cd frontend
9388
$ ng serve -o
9489
```
90+
![web_snip](sample/web_snip.JPG)
9591

9692
## 🤝 Contributing
9793

sample/cli_snip.JPG

28.6 KB
Loading

sample/ui.gif

-6.37 MB
Binary file not shown.

sample/web_snip.JPG

60.6 KB
Loading

0 commit comments

Comments
 (0)