|
1 | | -# Bootstrap Styled Motion |
| 1 | +# motion |
2 | 2 |
|
3 | | -Bootstrap Styled Motion provide CSS3 animation through a set of React Components and keyframes. |
| 3 | +[](https://travis-ci.org/bootstrap-styled/motion) [](https://www.npmjs.com/package/@bootstrap-styled/motion) [](https://www.npmjs.com/package/@bootstrap-styled/motion) [](https://npmjs.org/package/@bootstrap-styled/motion) [](https://npmjs.org/package/@bootstrap-styled/motion) [](https://www.npmjs.com/package/@bootstrap-styled/motion) [](https://www.npmjs.com/package/@bootstrap-styled/motion) |
| 4 | +[](https://sonarcloud.io/dashboard?id=com.github.bootstrap-styled.motion) [](https://sonarcloud.io/dashboard?id=com.github.bootstrap-styled.motion) |
4 | 5 |
|
5 | | -**Master** |
| 6 | +Bootstrap Styled Motion provide CSS3 animation through a set of React Components and keyframes |
6 | 7 |
|
7 | | -[](https://module.kopaxgroup.com/bootstrap-styled/bootstrap-styled-motion/commits/master) |
8 | | -[](https://module.kopaxgroup.com/bootstrap-styled/bootstrap-styled-motion/commits/master) |
9 | | - |
10 | | -**Dev** |
11 | | - |
12 | | -[](https://module.kopaxgroup.com/bootstrap-styled/bootstrap-styled-motion/commits/dev) |
13 | | -[](https://module.kopaxgroup.com/bootstrap-styled/bootstrap-styled-motion/commits/dev) |
14 | 8 |
|
15 | 9 | ## Table of Contents |
16 | 10 |
|
17 | | - - [Prerequisite](#prerequisite) |
18 | | - - [Installation](#installation) |
19 | | - - [Animation components](#animation-components) |
20 | | - - [Changelog](#changelog) |
21 | | - - [Quick start](#quick-start) |
22 | | - - [License](#license) |
| 11 | + - [Documentation](#documentation) |
| 12 | + - [Contributing](#contributing) |
| 13 | + - [License MIT](#license-mit) |
23 | 14 |
|
24 | 15 | --- |
25 | 16 |
|
26 | | -## Prerequisite |
27 | | - |
28 | | -```bash |
29 | | -$ npm install --save react react-dom styled-components |
30 | | -``` |
31 | | - |
32 | | -## Installation |
33 | | - |
34 | | -```bash |
35 | | -$ npm install --save bootstrap-styled-motion |
36 | | -``` |
37 | | - |
38 | | -## Animation components |
39 | | - |
40 | | -All our animations components are documented on [bootstrap-styled](https://bootstrap-styled.yeutech.com) documentation. |
41 | | - |
42 | | -```jsx harmony |
43 | | -import { |
44 | | - Blur, |
45 | | - Contrast, |
46 | | - Brightness, |
47 | | - Grayscale, |
48 | | - HueRotate, |
49 | | - Invert, |
50 | | - Opacity, |
51 | | - Sepia, |
52 | | - Saturate, |
53 | | - DropShadow, |
54 | | - Bounce, |
55 | | - BounceDown, |
56 | | - BounceUp, |
57 | | - BounceLeft, |
58 | | - BounceRight, |
59 | | - FadeIn, |
60 | | - FadeInDown, |
61 | | - FadeInUp, |
62 | | - FadeInLeft, |
63 | | - FadeInRight, |
64 | | - Flip, |
65 | | - FlipX, |
66 | | - FlipY, |
67 | | - LightIn, |
68 | | - LightOut, |
69 | | - RotateIn, |
70 | | - RotateLeft, |
71 | | - RotateRight, |
72 | | - RotateUpLeft, |
73 | | - RotateUpRight, |
74 | | - SlideUp, |
75 | | - SlideDown, |
76 | | - SlideRight, |
77 | | - SlideLeft, |
78 | | - SlideRightLeft, |
79 | | - Flash, |
80 | | - RollOut, |
81 | | - RollIn, |
82 | | - Rubber, |
83 | | - Swing, |
84 | | - Zoom, |
85 | | - Hinge, |
86 | | - Pulse, |
87 | | - ExpandUp, |
88 | | - Entrance, |
89 | | - Hatch, |
90 | | -} from 'bootstrap-styled-motion'; |
91 | | -``` |
92 | | - |
93 | | -## Changelog |
94 | | - |
95 | | - - View [Changelog](CHANGELOG.md) |
96 | | - |
97 | | -## Quick start |
98 | | - |
99 | | -Clone project |
100 | | - |
101 | | - git clone ssh://[email protected]:20024/bootstrap-styled/bootstrap-styled-motion.git |
102 | | - |
103 | | -Install dependencies |
104 | | - |
105 | | - npm install |
106 | | - |
107 | | -Build project |
108 | | - |
109 | | - npm run build |
110 | | - |
111 | | -Run unit test |
112 | | - |
113 | | - npm test |
114 | | - |
115 | | -Watch unit test |
116 | | - |
117 | | - npm run test:watch |
118 | | - |
119 | | -Watch the `/dist` directory |
120 | | - |
121 | | - npm run build:dist:watch |
122 | | - |
123 | | -Watch the `/lib` directory |
124 | | - |
125 | | - npm run build:lib:watch |
126 | | - |
127 | | -# Contribute |
128 | | - |
129 | | -`master` is used to release the version. |
130 | | - |
131 | | -- `master` only accept merge requests from `dev` |
132 | | - |
133 | | -`dev` is the development branch. It should be used by developers for applying their merge requests. |
134 | | - |
135 | | -If you wish to implement new features you need to do a merge request including your change on the `dev` branch. |
136 | | - |
137 | | - git checkout dev |
138 | | - git checkout $(whoami)-dev |
139 | | - git push -u origin $(whoami)-dev |
140 | | - |
141 | | -## License |
142 | | - |
143 | | -Licensed under the MIT License, Copyright © 2017-present Yeutech Company Limited. |
144 | | - |
145 | | -See [LICENSE](LICENSE.md) for more information. |
| 17 | +## Documentation |
| 18 | + |
| 19 | +Read [motion documentation](https://bootstrap-styled.github.io/motion). |
| 20 | + |
| 21 | + |
| 22 | +## Contributing |
| 23 | + |
| 24 | +If you want to contribute to motion please see our [contributing and community guidelines](https://github.com/bootstrap-styled/motion/blob/master/CONTRIBUTING.md), they\'ll help you get set up locally and explain the whole process. |
| 25 | + |
| 26 | +Please also note that all repositories under the bootstrap-styled organization follow our [Code of Conduct](https://github.com/bootstrap-styled/motion/blob/master/CODE_OF_CONDUCT.md), make sure to review and follow it. |
| 27 | + |
| 28 | +## License MIT |
| 29 | + |
| 30 | +The MIT License |
| 31 | + |
| 32 | +Copyright (c) 2017-2018 Yeutech Company Limited. https://bootstrap-styled.github.io/bootstrap-styled |
| 33 | + |
| 34 | +Permission is hereby granted, free of charge, to any person obtaining a copy |
| 35 | +of this software and associated documentation files (the "Software"), to deal |
| 36 | +in the Software without restriction, including without limitation the rights |
| 37 | +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 38 | +copies of the Software, and to permit persons to whom the Software is |
| 39 | +furnished to do so, subject to the following conditions: |
| 40 | + |
| 41 | +The above copyright notice and this permission notice shall be included in |
| 42 | +all copies or substantial portions of the Software. |
| 43 | + |
| 44 | +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 45 | +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 46 | +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 47 | +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 48 | +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 49 | +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 50 | +THE SOFTWARE. |
| 51 | + |
0 commit comments