@@ -13,10 +13,10 @@ Please be patient for first load. It may take some time as agents are loaded one
1313![ image] ( https://user-images.githubusercontent.com/5158436/27002340-c221cc06-4df4-11e7-9438-050a3ad8ecde.png )
1414
1515
16- ## Quick Setup
16+ ## Usage
1717
1818### Browser
19- Add this code to you to your page to enable Clippy2.
19+ For using in raw HTML/JS:
2020
2121``` html
2222<!-- Add the stylesheet to the head -->
@@ -50,6 +50,10 @@ clippy.load('Merlin', (agent) => {
5050 agent .show ();
5151});
5252```
53+
54+ ** NOTE** ` assets ` dir is not shipped with npm package for lighter package size.
55+ However it should work fine as assets are served from CDN by default. See [ CDN] ( #custom-cdn--agents ) section below.
56+
5357## Actions
5458All the agent actions are queued and executed by order, so you could stack them.
5559
@@ -82,14 +86,14 @@ agent.stop();
8286
8387## Custom CDN / Agents
8488By default all agents are being served from GitHub CDN (this repo) in order to customize loading base path,
85- You can set ` window.CLIPPY_CDN ` or use 4rd argument of ` load ` function it can be absolute URL or relative to script.
89+ You can set ` window.CLIPPY_CDN ` or use fourth argument of ` load ` function it can be absolute URL or relative to script.
8690(** path should end with slash /** )
8791
8892``` js
8993// Using global config
9094window .CLIPPY_CDN = ' ./agents/'
9195
92- // Or using 4rth argument
96+ // Or using fourth argument
9397clippy .load (' Marline' , function () {
9498 // ...
9599}, undefined , ' ./agents/' )
0 commit comments