Skip to content

Commit 1ee2ca2

Browse files
committed
docs(readme): Added docs with image, updated demo
- Added extensive documentation to the README file - Added animated GIF image and badges - Updatd demo, updated demo styles - Updated ignore files - Updated package.json description - Updated a few default configuration values
1 parent 0e21209 commit 1ee2ca2

File tree

14 files changed

+800
-65
lines changed

14 files changed

+800
-65
lines changed

.gitignore

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
/src/**/*.js.map
1212
/src/**/*.metadata.json
1313

14-
# Build: CSS plus sourcemaps
14+
# Build: SASS output
1515
/style.css
1616
/style.css.map
1717
/src/styles/**/*.css
@@ -27,12 +27,12 @@
2727
/demo/*.js
2828
!/demo/systemjs.config.js
2929

30-
# Logs
31-
*.log
32-
3330
# Development
3431
/.vscode
3532

33+
# Logs
34+
*.log
35+
3636
# Other
3737
*.todo
3838
*.old

.npmignore

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
# Dependencies
22
/node_modules
33

4-
# TypeScript source code
4+
# Source code
55
/index.ts
66
/src/**/*.ts
7+
/src/**/*.html
78
!/src/**/*.d.ts
89

9-
# Build: Tests
10+
# Build: Test output
1011
/src/**/*.spec.js
1112

12-
# Demo
13-
/demo
14-
1513
# Build: Temp folder
1614
/temp
1715

16+
# Demo
17+
/demo
18+
1819
# Not needed files
1920
/tools
2021
/.gitignore

0 commit comments

Comments
 (0)