Skip to content

Commit f06f3eb

Browse files
committed
Readme updated
1 parent a755f77 commit f06f3eb

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

+16-6
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ Check the results of this simple project:
2525
![](screenshots/animation-pink.gif)
2626

2727
##### See it live at [pixelart-to-css-react](http://pixelart.jvrpath.com/)
28-
#### Help me to improve it, share and enjoy :)
2928

3029
## Technical overview
3130

32-
This application has been built with the following technoligies:
31+
This application has been built with the following technologies:
3332

34-
- [React](https://facebook.github.io/react/) (Library to build the UI)
35-
- [Redux](http://redux.js.org/) (Implement Flux architecture)
33+
- [React](https://facebook.github.io/react/): Library to build the UI
34+
- [Redux](http://redux.js.org/): Implements a Flux like architecture
3635
- [ImmutableJS](https://facebook.github.io/immutable-js/) Helps to keep the data immutable
36+
- [PostCSS](https://github.com/postcss/postcss) Handle the app CSS
3737
- [NodeJS](https://nodejs.org/en/) + [Express](http://expressjs.com/) (Server side to build an universal application, create and serve the generated drawings)
3838

3939
## Installation
@@ -44,15 +44,15 @@ npm run install
4444

4545
## Development
4646

47-
If you just want to develop the interface with no need of back-end side, taking advance of ```webpack-dev-server``` and ```react-hot-loader```.
47+
If you just want to develop the interface with no need of back-end side, take advance of ```webpack-dev-server``` and ```react-hot-loader```.
4848

4949
```bash
5050
npm run development
5151
```
5252

5353
## Deploy
5454

55-
Create the final build and run the generated react html on a express server making in an isomorphic/universal way.
55+
Create the final build and run the generated react html on a express server making in an isomorphic way.
5656

5757
```bash
5858
npm run deploy
@@ -67,3 +67,13 @@ A ```config.json``` is needed for deployment with the Twitter and express keys.
6767
```bash
6868
npm run test
6969
```
70+
71+
## Contributing
72+
#### Help me to improve it, share and enjoy :)
73+
Please create a Github issue if there is something wrong or to be improved. Pull request are also welcome and they can be created to the develop branch.
74+
75+
76+
## License
77+
78+
[MIT](https://opensource.org/licenses/mit-license.php)
79+
Copyright © 2016 Javier Valencia Romero (@jvalen)

0 commit comments

Comments
 (0)