Skip to content
This repository was archived by the owner on Jan 2, 2021. It is now read-only.

Commit 35a76f7

Browse files
committed
Updated readme
1 parent fffdb9e commit 35a76f7

6 files changed

Lines changed: 31 additions & 37 deletions

File tree

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,49 @@
1-
# QR Code Scanner
1+
### <p align="center"><img width="150px" height="150px" src="https://raw.githubusercontent.com/code-kotis/barcode-scanner/master/logo.png"></p>
2+
3+
# [QR Code Scanner](https://qrcodescan.in)
24

35
*A progressive web application*
46

5-
#[Live](https://qrcodescan.in)
7+
### [Live](https://qrcodescan.in)
68

79
## Features
810

11+
- Served via https - Using [cloudflare free ssl](https://www.cloudflare.com/ssl/)
12+
913
- Works offline
1014

11-
- Add to home screen
15+
- Add to home screen, Splash screen
1216

1317
- Fully responsive
1418

15-
- App shell architecture using [material design lite](https://www.getmdl.io/)
19+
- App shell architecture - [material design lite](https://www.getmdl.io/)
1620

1721
- Supported browser - Google Chrome, Firefox, Opera (Both Desktop & Mobile)
1822

1923
## Installation
2024

21-
1. Clone the repo
25+
1. Clone this repo
2226

2327
```bash
2428
git clone https://github.com/code-kotis/barcode-scanner
2529
```
2630

27-
2. Build installation
31+
2. Install dependencies
2832
```bash
2933
npm install
3034
```
3135

32-
3. Run the project
36+
3. Run
3337
```bash
34-
gulp
38+
npm run start
39+
```
40+
4. Deploy in github pages
41+
```bash
42+
npm run deploy
3543
```
3644

3745
### Contributions
3846

3947
If you find a bug, please file an issue. PR's are most welcome ;)
48+
49+
#### MIT Licensed

deploy.sh

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
git add -f dist
2+
git commit -am "Deployed website"
3+
git filter-branch -f --prune-empty --subdirectory-filter dist
4+
git push -f origin gh-pages
5+
git checkout -

gulpfile.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ gulp.task('copy:images', () => {
6868
gulp.task('copy:others', () => {
6969
console.log('Coping other files...');
7070

71-
return gulp.src(['app/manifest.json'])
71+
return gulp.src(['app/manifest.json', 'CNAME', 'robots.txt'])
7272
.pipe(gulp.dest('dist'));
7373
});
7474

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
"vinyl-source-stream": "^1.1.0"
3636
},
3737
"scripts": {
38-
"start": "node server.js",
39-
"build": "gulp clean && gulp"
38+
"start": "gulp clean && gulp",
39+
"deploy": "bash deploy.sh"
4040
}
4141
}

robots.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# www.robotstxt.org/
2+
3+
# Allow crawling of all content
4+
User-agent: *
5+
Disallow:

server.js

Lines changed: 0 additions & 26 deletions
This file was deleted.

0 commit comments

Comments
 (0)