Skip to content

Commit d872806

Browse files
authored
Update README.md
1 parent 66401aa commit d872806

File tree

1 file changed

+27
-5
lines changed

1 file changed

+27
-5
lines changed

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,26 +68,28 @@ My test procedure:
6868
## Usage
6969

7070
#### Dev Workflow
71-
1. `npm run bundle-dev` - _**OPTIONAL:** run only when your dependencies has changed_
71+
1. `npm run bundle-dev` - _**OPTIONAL:** re-run only when your dependencies has changed_
7272
2. `npm start`
7373

7474
#### Build for Production Workflow
7575
1. `npm run build`
76-
2. `npm run build-deps` - _**OPTIONAL:** run only when your dependencies has changed_
76+
2. `npm run build-deps` - _**OPTIONAL:** re-run only when your dependencies has changed_
7777
3. open `http://localhost/dist/` to check
7878
4. deploy 'dist' contents on your server
7979

80-
#### Npm Commands
80+
---
81+
82+
## All Npm Commands & Scripts
8183

8284
`npm start` - start local dev server with hot-module-reload for JSPM [jspm-hmr](https://www.npmjs.com/package/jspm-hmr)
8385

84-
##### Development Bundling
86+
#### Development Bundling
8587

8688
`npm run bundle-dev` - bundle static dependencies for quick full-page reload, app sources remain as seperate modules for on-the-fly HMR & transpilation
8789

8890
`npm run unbundle` - un-bundle static dependencies (usefull when changing app dependencies)
8991

90-
##### Production Bundling (`dist/` folder)
92+
#### Production Bundling (`dist/` folder)
9193

9294
`npm run build` - build app bundle (only your app source) - minified, no source-maps
9395

@@ -97,6 +99,26 @@ My test procedure:
9799

98100
`npm run build-debug` - build app bundle - debug version with source-maps
99101

102+
#### Deployment
103+
104+
`npm run init-deploy` - initialize new git repository in `/dist` folder aiming at gh-pages branch
105+
106+
`npm run deploy` - checkout, add, commit and push changes in `/dist` folder to gh-pages branch
107+
108+
#### Utility & Git Hooks
109+
110+
`npm run bd` - build and deploy your app bundle
111+
112+
`npm run bdd` - build and deploy your deps bundle
113+
114+
`npm run lint` - run linter
115+
116+
`npm run test` - run test suites
117+
118+
`npm run precommit` - pre commit git hook - runs linter
119+
120+
`npm run prepush` - pre push git hook - runs linter and tests
121+
100122
---
101123

102124
## Dependencies

0 commit comments

Comments
 (0)