Update README

common-lib/CONTRIB.md

@@ -1,17 +1,20 @@
 
 ## Panels overview
 
-All panels in this lib should implement one or more functions: 
+All panels in this lib should implement one of the following methods: 
 
-- panel.new(title,targets,description) - creates new panel. List of arguments could vary;
-- panel.stylize() - directly applies this panel style to existing panel;
-- panel.stylizeByRegexp(regexp) - attaches style as panel overrides (by regexp);
-- panel.stylizeByName(name) - attaches style as panel overrides (by name);
+- `panel.new(title,targets,description)` - creates new panel. List of arguments could vary;
+- `panel.stylize(allLayers=true)` - directly applies this panel style to existing panel. By default includes all layers of styles. To apply only top layer, set allLayers=false. This mode is useful to cherry-pick style layers to create new style combination.
+
+Some other methods could be found such as:
+- `panel.stylizeByRegexp(regexp)` - attaches style as panel overrides (by regexp);
+- `panel.stylizeByName(name)` - attaches style as panel overrides (by name).
 
 ## Panels common groups
 
 This library consists of multiple common groups of panels for widely used resources such as CPU, memory, disks and so on.
 
 All of those groups inherit `generic` group as their base.
 
-All panels should inherit `generic/base.libsonnet` via `generic/<paneltype>/base.libsonnet`.
+All panels inherit `generic/base.libsonnet` via `generic/<paneltype>/base.libsonnet`.
+

common-lib/README.md

@@ -13,14 +13,21 @@ jb install https://github.com/grafana/jsonnet-libs/common-lib
 
 ## Use
 
+### Create new panel
+
 ```jsonnet
 
 local commonlib = import 'github.com/grafana/jsonnet-libs/common-lib/common/main.libsonnet';
+local cpuUsage = commonlib.panels.cpu.timeSeries.utilization.new(targets=[targets.cpuUsage]);
+
+```
 
-local panels = {
-  cpuUsage: commonlib.panels.cpu.timeSeries.utilization.new(targets=[targets.cpuUsage]),
-}
+### Mutate exisiting panel with style options
 
+```jsonnet
+
+local commonlib = import 'github.com/grafana/jsonnet-libs/common-lib/common/main.libsonnet';
+local cpuPanel = oldPanel + commonlib.panels.cpu.timeSeries.utilization.stylize();
 ```
 
 See [windows-observ-lib](./windows-observ-lib) for full example.