Skip to content

Commit 440655c

Browse files
andrerpenaandrerpena
committed
Making the documentation better
1 parent 37610f2 commit 440655c

File tree

2 files changed

+99
-12
lines changed

2 files changed

+99
-12
lines changed

‎LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2016 Redux Autoform
3+
Copyright (c) 2016 redux-autoform-bootstrap-ui
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md

+98-11
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,79 @@ Bootstrap UI for [redux-autoform](https://github.com/redux-autoform/redux-autofo
88

99
> Be patient. This documentation is still under construction. Pull-requests are welcome.
1010
11-
Components
12-
---
11+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
12+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
13+
14+
15+
- [Introduction](#introduction)
16+
- [Getting started](#getting-started)
17+
- [Using](#using)
18+
- [Add the required third-party components](#add-the-required-third-party-components)
19+
- [Styling](#styling)
20+
- [Components](#components)
21+
- [TextBox](#textbox)
22+
- [TextArea](#textarea)
23+
- [CheckBox](#checkbox)
24+
- [Select](#select)
25+
- [Lookup](#lookup)
26+
- [DateTimePicker](#datetimepicker)
27+
- [Specific metadata for the `DateTimePicker` component. Common metadata is not listed.](#specific-metadata-for-the-datetimepicker-component-common-metadata-is-not-listed)
28+
- [Contributing](#contributing)
29+
- [Third party](#third-party)
30+
- [License](#license)
31+
32+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
33+
34+
## Introduction
35+
36+
Bootstrap UI for [redux-autoform](https://github.com/redux-autoform/redux-autoform).
37+
38+
## Getting started
39+
40+
### Using
41+
42+
First, make sure you are familiar with [redux-autoform](https://github.com/redux-autoform/redux-autoform) and that you've read the [getting started section](https://github.com/redux-autoform/redux-autoform#using).
43+
44+
This project provides component factories for redux-autoform:
45+
46+
```js
47+
import { EditComponentFactory, DetailsComponentFactory } from 'redux-autoform-bootstrap-ui';
48+
```
49+
50+
Now all you have to do is to use AutoForm an pass one of the above factories as the `componentFactory` prop of the Autoform component. You can see the AntuForm props [here](https://github.com/redux-autoform/redux-autoform/blob/master/docs-md/documentation.md#autoform).
51+
52+
### Add the required third-party components
53+
54+
Components that are installed automatically:
1355

14-
###TextBox###
56+
- [redux-form](https://github.com/erikras/redux-form/).
57+
- [react-bootstrap](http://react-bootstrap.github.io/).
1558

59+
Components that are need to be installed manually:
60+
61+
- [react-select](https://github.com/JedWatson/react-select).
62+
- [react-widgets](https://github.com/jquense/react-widgets).
63+
64+
### Styling
65+
66+
- Import `styles.less` file. This file contains infrastructural styling.
67+
- Import `styles-defaultfactories.less`. This file contains styles related to the components used in the Bootstrap factories. (ToDo: Rename this file to `bootstrap.theme.less`)
68+
- import the thid-party styles for the components used in the default factories. The example below lists what have to be imported:
69+
70+
**yourstyles.less**:
71+
72+
@import './node_modules/bootstrap/less/bootstrap.less';
73+
@import './node_modules/font-awesome/less/font-awesome.less';
74+
@import './node_modules/react-widgets/dist/css/react-widgets.css';
75+
@import './node_modules/react-select/dist/react-select.css';
76+
@import './node_modules/redux-autoform/lib/less/styles';
77+
@import './node_modules/redux-autoform/lib/less/styles-defaultfactories';
78+
79+
Alternatively, if you're using webpack with `css-loader` and `less-loader`, which you probably are, you can just import these less files directly in your JavaScript.
80+
81+
## Components
82+
83+
### TextBox
1684

1785
Specific metadata for the `TextBox` component. Common metadata is not listed.
1886

@@ -24,7 +92,7 @@ addonAfter | The text that should be added-on after the component.
2492

2593
[TextBox demo](http://gearz-lab.github.io/redux-autoform/demo.html?preset=componentsTextBox)
2694

27-
###TextArea
95+
### TextArea
2896
---
2997

3098
Specific metadata for the `TextBox` component. Common metadata is not listed.
@@ -38,12 +106,12 @@ rows | The number of rows.
38106

39107
[TextArea demo](http://gearz-lab.github.io/redux-autoform/demo.html?preset=componentsTextArea)
40108

41-
###CheckBox
109+
### CheckBox
42110
---
43111

44112
[Checkbox demo](http://gearz-lab.github.io/redux-autoform/demo.html?preset=componentsCheckbox).
45113

46-
###Select
114+
### Select
47115
---
48116

49117
Specific metadata for the `Select` component. Common metadata is not listed.
@@ -54,7 +122,7 @@ options | The options to display. Options are an array of objects with two prope
54122

55123
[Select demo](http://gearz-lab.github.io/redux-autoform/demo.html?preset=componentsSelect).
56124

57-
###Lookup
125+
### Lookup
58126
---
59127

60128
Specific metadata for the `Lookup` component. Common metadata is not listed.
@@ -65,10 +133,10 @@ options | The options to display. Options are an array of objects with two prope
65133

66134
[Lookup demo](http://gearz-lab.github.io/redux-autoform/demo.html?preset=componentsLookup).
67135

68-
###DateTimePicker
136+
### DateTimePicker
69137
---
70138

71-
###Specific metadata for the `DateTimePicker` component. Common metadata is not listed.
139+
### Specific metadata for the `DateTimePicker` component. Common metadata is not listed.
72140

73141
Metadata | Description
74142
--- | ---
@@ -78,12 +146,31 @@ format | Any format supported by [Moment.js](http://momentjs.com/docs/#/parsing/
78146
[DateTimePicker demo](http://gearz-lab.github.io/redux-autoform/demo.html?preset=componentsDateTimePicker).
79147

80148

81-
##Third party
149+
## Contributing
150+
151+
**Pull-requests are really really welcome**. If you don't know what to contribute with, please check the [issues](https://github.com/redux-autoform/redux-autoform-bootstrap-ui/issues).
152+
153+
We'll be more than glad to invite frequent contributors to join the organization.
154+
If you need help understanding the project, please post an issue and I'll do my best to reply and make sure you understand everything
155+
you need.
156+
157+
In order to make a pull request:
82158

159+
1. Fork it.
160+
2. Create your feature-branch git checkout -b your-new-feature-branch
161+
3. Commit your change git commit -am 'Add new feature'
162+
4. Push to the branch git push origin your-new-feature-branch
163+
5. Create new Pull Request with master branch
83164

84-
The `DefaultComponentFactory` relies on third-party components. Here's the list:
165+
## Third party
166+
167+
Components this project rely on:
85168

86169
- [redux-form](https://github.com/erikras/redux-form/).
87170
- [react-bootstrap](http://react-bootstrap.github.io/).
88171
- [react-select](https://github.com/JedWatson/react-select).
89172
- [react-widgets](https://github.com/jquense/react-widgets).
173+
174+
License
175+
---
176+
`redux-autoform` is [MIT](https://github.com/redux-autoform/redux-autoform-bootstrap-ui/blob/master/LICENSE) licensed.

0 commit comments

Comments
 (0)