fix some docs

CHANGELOG.md

@@ -1,10 +1,8 @@
 # 3.1.0
 ### New features
 - #43 `ButtonsConfig` object to configure button's visibility
-- #57 `KeyboardConfig` object to customize keyboard shortcuts (replacing esc, left arrow, right arrow, with other keys)
+- #57 `KeyboardConfig` object to customize keyboard's actions (replacing `esc`, `left arrow`, `right arrow`, with other keys)
 - #40 new @Input to enable Click outside Directive to close modal-gallery clicking on the semi-transparent background
-- #59 basic tslint config for angular-modal-gallery lib
-- #41 unit testing
 - #67 Angular 2 is still supported
 
 ### Docs
@@ -16,15 +14,17 @@
 
 ### Bug fixes
 - #64 hasData event emitted multiple time while initializing the component
-- #65 wrong result into imagemodalevent when clicking left arrow button
+- #65 wrong result into ImageModalEvent when clicking left arrow button
 
 ### Chores
 - #63 Add minimum IE version supported by this library (IE 11)
 
 ### Internal library changes
+- #41 unit testing
+- #59 basic tslint config for angular-modal-gallery lib
 - #69 improve CIs config for unit testing (adding also coveralls ad codeclimate's reports)
 - #60 build env with npm>=5.0.0 and node>=8.0.0
-- #61 replace elementref with renderer to support angular-universal (still not supported, but this is the first step)
+- #61 replace elementref with renderer to prepare this project to angular-universal (still not supported, but this is the first step)
 
 
 # 3.0.2

DEVELOPER.md

@@ -17,36 +17,37 @@ Every time you'll run `npm install` inside a demo's folder, you must rebuild the
 8. `cd demo/webpack`
 9. `npm install`
 10. `cd ../..`
-11. `cd demo/angular-cli/angular-modal-gallery-angularcli-demo`
+11. `cd demo/angular-cli`
 12. `npm install`
 13. `cd ../../..`
 14. `npm run build`
-15. `npm run test` => if everything is ok, go to the next step
-16. `cd demo/systemjs`
-17. `npm start` => if everything is ok (also in browser's console), kill the process and go to the next step
-18. `cd ../..`
-19. `cd demo/webpack`
-20. `npm start` => if everything is ok (also in browser's console), kill the process and go to the next step
-21. `npm run build:dev`
-22. `cd dist`
-23. `lite-server` => everything is ok (also in browser's console)? if yes go to the next step
-24. `cd ..`
-25. `npm run build:prod`
-26. `cd dist`
-27. `lite-server` => everything is ok (also in browser's console)? if yes go to the next step
-28. `cd ..`
-29. `npm run build:prod:aot` (if necessary re-follow all the steps from the beginning)
-30. `cd dist`
-31. `lite-server` => everything is ok (also in browser's console)? if yes go to the next step
-32. `cd ../../..`
-33. `cd demo/angular-cli/angular-modal-gallery-angularcli-demo`
-34. `ng serve` => if everything is ok (also in browser's console), kill the process and go to the next step
-35. `ng build`
-36. `cd dist`
-37. `lite-server` => everything is ok (also in browser's console)? if yes go to the next step
-38. `cd ..`
-39. `ng test` => if everything is ok, go to the next step
-40. If it is ok, create your pull request.
+15. `npm run test` => if everything is ok, try to open `./coverage/html/index.html` with the `code coverage`
+16. `npm run docs` => try to open `./docs/index.html` with the `internal library documentation`
+17. `cd demo/systemjs`
+18. `npm start` => if everything is ok (also in browser's console), kill the process and go to the next step
+19. `cd ../..`
+20. `cd demo/webpack`
+21. `npm start` => if everything is ok (also in browser's console), kill the process and go to the next step
+22. `npm run build:dev`
+23. `cd dist`
+24. `lite-server` => if everything is ok (also in browser's console), kill the process and go to the next step
+25. `cd ..`
+26. `npm run build:prod`
+27. `cd dist`
+28. `lite-server` => if everything is ok (also in browser's console), kill the process and go to the next step
+29. `cd ..`
+30. `npm run build:prod:aot` (if necessary re-follow all the steps from the beginning)
+31. `cd dist`
+32. `lite-server` => if everything is ok (also in browser's console), kill the process and go to the next step
+33. `cd ../../..`
+34. `cd demo/angular-cli`
+35. `npm start` => if everything is ok (also in browser's console), kill the process and go to the next step
+36. `npm run build`
+37. `cd dist`
+38. `lite-server` => if everything is ok (also in browser's console), kill the process and go to the next step
+39. `cd ..`
+40. `npm test` => if everything is ok, kill the process and go to the next step
+41. **If it is ok, create your pull request**
 
 
 

README.md

@@ -14,9 +14,12 @@
 
 <br>
 
-An Angular library to create an image gallery of **clickable thumbnails**. After a click, it will display a **modal window with full screen images**.
+**angular-modal-gallery** is an Angular library to create image galleries of **clickable thumbnails**. After a click, it will display a **modal window with full screen images**.
 It's also possible to navigate between these images with both **keyboard arrows**, **swipe gestures** and **mouse** clicks and close it pressing **`esc`**.
-Starting from version 3, you can **download images** (with the button or with the **keyboard shortcut ctrl+s / cmd+s**) or navigate to an **external url**.
+
+Starting from version 3, you can **download images** (with either the button or with **keyboard shortcut ctrl+s / cmd+s**) or navigate to an **external url**.
+
+Version 3.1.x includes other cool features, for instance **advanced configurations** and a **click outside** feature to close the modal gallery.
 
 This project was born as a fork of [THIS REPO](https://github.com/vimalavinisha/angular2-image-popup).
 
@@ -58,7 +61,7 @@ If you have issues, try to install also:
 - Angular >= 2 (Angular 4 officially supported from version 3.0.2, but also working with both 3.0.0 and 3.0.1)
 - Tested with Webpack 2 + Treeshaking and also inside a Lazy loaded module (check `demo/webpack`)
 - Tested with SystemJs 0.20.x and Angular-cli 1.x.x
-- and so on...
+- and so on... (check the official documentation [HERE](https://ks89.github.io/angular-modal-gallery.github.io/))
 
 
 ## How to use it?
@@ -73,9 +76,11 @@ Two different ways (both of them are good):
 Check `CONTRIBUTING.md` in this repository
 
 
-## Developer informations
+## Developer information
+
+Check `DEVELOPER.md` in this repository to build and test this library.
 
-Check `DEVELOPER.md` in this repository
+Also, if you want to generate the `internal library documentation`, run `npm run docs` and open `./docs/index.html`.
 
 
 ## License