Skip to content

Commit 91d4904

Browse files
committed
update the Readme
1 parent f12ede7 commit 91d4904

File tree

2 files changed

+997
-2294
lines changed

2 files changed

+997
-2294
lines changed

README.md

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ Currently we have 2 regular modules which can be added to the angular-app you ar
136136
- __ui.scroll__ module which has
137137
- [uiScroll directive](#uiscroll-directive)
138138
- [uiScrollViewport directive](#uiscrollviewport-directive)
139-
- [jqLiteExtras service](#jqliteextras-service) (with runner)
139+
- [jqLiteExtras constant](#jqliteextras-constant) (with runner)
140140
- __ui.scroll.grid__ module which has
141141
- [uiScrollTh directive](#uiscrollth-and-uiscrolltd-directives)
142142
- [uiScrollTd directive](#uiscrollth-and-uiscrolltd-directives)
@@ -349,9 +349,9 @@ the browser window object will be used as viewport.
349349
-------------------
350350

351351

352-
## jqLiteExtras service
352+
## jqLiteExtras constant
353353

354-
This service implements some DOM element methods of jQuery which are currently not implemented in jqLite, namely
354+
This constant is a class that implements some DOM element methods of jQuery which are currently not implemented in jqLite, namely
355355

356356
* before(elem)
357357
* height() and height(value)
@@ -425,8 +425,7 @@ A reference to this object is injected as a property named `gridAdapter`in the s
425425
Please feel free to make Pull Requests. Below is the information which could be useful for local developing and contributing.
426426

427427
The ui-scroll sources are in [./src](https://github.com/angular-ui/ui-scroll/tree/master/src) folder. They could not be run as is
428-
because of ES6 modules (since v1.6.0), they should be built. Build process includes jshint sources verification, webpack-based
429-
distributive files forming and tests running.
428+
because of ES6 modules (since v1.6.0), they should be built. The build process includes jshint sources verification, distributive files generating and tests running.
430429

431430
There are some npm scripts available for developing.
432431

@@ -436,43 +435,36 @@ There are some npm scripts available for developing.
436435
npm start
437436
```
438437

439-
This should start development server on 5005 port over the [./demo](https://github.com/angular-ui/ui-scroll/tree/master/demo) folder.
440-
The middleware is configured to provide work with temporary distributive files (./temp) despite the direct links to public distributive
441-
files (./dist). So the dist-folder should stay clear until the development is finished. Dev-server watches for the source codes (./src)
442-
and automatically re-build temporary distributive files.
438+
This should start development server on 5005 port over the [./demo](https://github.com/angular-ui/ui-scroll/tree/master/demo) folder. The dev-server proxy is configured to provide work with temporary distributive files (which are being built in-memory each time the sources from ./src have been changed) despite the direct links to public distributive files form ./dist folder. So the dist-folder should stay clear until the development is finished.
443439

444440
__2__. To run tests in keep-alive mode use
445441

446442
```
447443
npm test
448444
```
449445

450-
This runs karma testing against temporary distributive files (./temp). We created a number of specifications which consist of more
451-
than 160 tests. They are living at the [./test](https://github.com/angular-ui/ui-scroll/tree/master/test) folder. Karma watches for temp
452-
and test folders changes and automatically re-runs tests.
446+
This runs Karma testing against temporary distributive files that are being built in-memory by the Webpack. We created a number of specifications which consist of more than 200 tests. They are living at the [./test](https://github.com/angular-ui/ui-scroll/tree/master/test) folder. Karma watches both for ./src and ./test folders and automatically re-runs tests after the source code has been changed.
453447

454448
__3__. To run both dev-server and tests in keep-alive mode use
455449

456450
```
457451
npm run dev
458452
```
459453

460-
This is the combination of first two scripts running in concurrently mode. This allows you to work with the ui-scroll examples on 5005 port
461-
during continuous tests running.
454+
This is the combination of first two scripts running in concurrently mode. This allows you to work with the ui-scroll examples on 5005 port during continuous tests running.
462455

463456
__4__. To run full build process use
464457

465458
```
466459
npm run build
467460
```
468461

469-
After developing and testing complete, the build process should be run to
470-
a) pass through jshint,
471-
b) generate minified versions of distributive,
472-
c) run tests with minified distributive files,
473-
d) obtain all necessary files in the [./dist](https://github.com/angular-ui/ui-scroll/tree/master/dist) folder.
462+
After developing and testing are completed, the build process should be run to
463+
a) pass through jshint (both of ui-scroll and test specifications sources),
464+
b) generate compressed and uncompressed versions of the ui-scroll distributive in the public [./dist](https://github.com/angular-ui/ui-scroll/tree/master/dist) folder,
465+
c) run tests over minified distributive files.
474466

475-
PR should include source code (./scr) changes, may include tests (./test) changes and may not include public distributive (./dist) changes.
467+
Pull Rerquest should include source code (./scr) changes, may include tests (./test) changes and may not include public distributive (./dist) changes.
476468

477469

478470
-------------------
@@ -486,7 +478,7 @@ PR should include source code (./scr) changes, may include tests (./test) change
486478
* Reconsidered min/max indices processing.
487479
* Refactored tests (removed timeouts, added helpers).
488480
* Added ~50 new tests.
489-
* Fixed a number of issues.
481+
* Fixed a number of issues and other improvements.
490482

491483
### v1.6.2
492484
* Added bottomVisible, bottomVisibleElement and bottomVisibleScope properties to the Adapter.

0 commit comments

Comments
 (0)