Skip to content

Commit 9e524f9

Browse files
Update README.md
1 parent 2ee6880 commit 9e524f9

File tree

1 file changed

+42
-2
lines changed

1 file changed

+42
-2
lines changed

README.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
## Widgets
2+
13
- select2: [site](https://select2.org/), [repo](https://github.com/select2/select2), license: MIT
24

35
- select2tagbox: [site](https://select2.org/), [repo](https://github.com/select2/select2), license: MIT
@@ -20,6 +22,44 @@
2022

2123
- ckeditor: [site](https://ckeditor.com/ckeditor-4/), [repo](https://github.com/ckeditor/ckeditor-dev), license: https://github.com/ckeditor/ckeditor-dev/blob/major/LICENSE.md
2224

23-
24-
# examples of usage
25+
## Getting started
26+
es5 examples: https://surveyjs.io/Examples/Library/?id=custom-widget-select2-tagbox
2527
es moules examples: https://stackblitz.com/edit/surveyjs-widgets-react
28+
29+
Install the library using npm.
30+
31+
```
32+
npm install surveyjs-widgets
33+
```
34+
35+
Or use Azure CDN:
36+
https://surveyjs.azureedge.net/0.95.0/surveyjs-widgets.min.js
37+
38+
You find all versions/builds in the [surveyjs/build repo](https://github.com/surveyjs/builds).
39+
40+
41+
## Building surveyjs-widgets from sources
42+
43+
To build library yourself:
44+
45+
1. **Clone the repo from GitHub**
46+
```
47+
git clone https://github.com/surveyjs/surveyjs-widgets.git
48+
cd surveyjs-widgets
49+
```
50+
51+
2. **Acquire build dependencies.** Make sure you have [Node.js](http://nodejs.org/) installed on your workstation. This is only needed to _build_ surveyjs from sources.
52+
```
53+
npm install
54+
```
55+
56+
3. **Build the library**
57+
```
58+
npm run build
59+
```
60+
After that you should have the libraries (angular, jquery, knockout, react and vue) at 'packages' directory.
61+
62+
63+
## License
64+
65+
[MIT license](https://github.com/surveyjs/widgets/blob/master/LICENSE)

0 commit comments

Comments
 (0)