Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
abmaonline committed May 7, 2018
1 parent f79dcb7 commit 9e364ce
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
# aemfed changelog

## 0.0.2

### Proxy multiple targets

* Initial support for proxying all provided targets
* Each target maintains and updates its own dumplibs clientlib tree
* Prefix log messages with target name
* BrowserSync proxy ports start at default (3000) and increase by two (proxy + ui) for each provided target, in same order as targets on command line

### Integrate clientlib error logging

* Show clientlib related errors for a request in console using Sling log tracers. It shows serverside errors for Less compilation and minification using the YUI and GCC
* Read and store OSGi config to see if tracers are enabled and show instructions on how to enable on dev

### Other

* Add browsersync cache buster also on initial requests to stop using cached code on reload and make styling injection smoother on Firefox
* Update several dependencies and rewrite for new aemsync 3.0 structure using Pipeline
* Use patched version of aemsync to fix package manager clutter

## 0.0.1

### Initial release
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Speed up your AEM front-end development using [aemsync](https://www.npmjs.com/pa
* Watches changes in files and uploads them to AEM using [aemsync](https://www.npmjs.com/package/aemsync)
* Determines which clientlibs are affected by the uploaded changes
* Runs [BrowserSync](https://www.npmjs.com/package/browser-sync) in proxy modus so it can communicate with all open instances of your site without any browser plugins. It reloads these pages when the changes have been uploaded, or it only injects the new styling when only styling changes were made, maintaining the state of the page.
* Show serverside clientlib errors for each request

## Installation

Expand Down Expand Up @@ -55,10 +56,13 @@ Once started, connect your browser to the local access URL and port provided by
## Requirements

* Works best with a recent version of node/npm, but tested with node 6.x
* Tested on AEM 6.1 and 6.3
* Tested on AEM 6.1, 6.3 SP1 and 6.3 SP2

## Isues

* When sending a clientlib to BrowserSync that is not included in the page, all styling is reloaded. Issue in BrowserSync, will be fixed in future release: [#1505](https://github.com/BrowserSync/browser-sync/issues/1505)
* Using ~ (homedir) in paths to watch does not work as expected when aemfed does all the path processing (paths are surrounded with quotes)
* YUI minification generates errors for each request if there is an error (Less and GCC generate errors only first time after a resource was changed)
* Less variables are not supported in imports

Thanks to the [BrowserSync](https://www.npmjs.com/package/browser-sync) team, to [gavoja](https://github.com/gavoja) for [aemsync](https://www.npmjs.com/package/aemsync) and [kevinweber](https://github.com/kevinweber) for [aem-front](https://www.npmjs.com/package/aem-front).

0 comments on commit 9e364ce

Please sign in to comment.