Skip to content

Commit f2be1f1

Browse files
committed
edit readme
1 parent b85e883 commit f2be1f1

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,38 @@
1-
#vue-formly-bootstrap
1+
#vue-formly-bootstrap
2+
A plugin for [Vue Formly](https://github.com/matt-sanders/vue-formly) which adds multiple form fields according to Twitter Bootstrap.
3+
4+
##Installation
5+
```
6+
npm install vue-formly-bootstrap
7+
```
8+
or if you can just include the script:
9+
```html
10+
<script src="/path_to_folder/vue-formly-bootstrap/dist/vue-formly-bootstrap.js"></script>
11+
```
12+
13+
##Usage
14+
```
15+
import VueFormly from 'vue-formly');
16+
import VueFormlyBootstrap from 'vue-formly-bootstrap';
17+
Vue.use(VueFormly);
18+
Vue.use(VueFormlyBootstrap);
19+
```
20+
If you include the script it will be installed for you.
21+
22+
Note that this is still a work in progress so some fields are under construction. See the To Do section for what's on the watchlist.
23+
24+
##Options
25+
Coming soon...
26+
27+
##To Do
28+
* [x] Input
29+
* [ ] Select
30+
* [ ] Text Area
31+
* [ ] Checkbox
32+
* [ ] Radio Buttons
33+
* [ ] Date Picker
34+
* [ ] Other funky form inputs
35+
* [ ] Dirty/Clean checking
36+
* [ ] Hide/Show options
37+
* [ ] Custom attributes
38+
* [ ] Custom Classes

0 commit comments

Comments
 (0)