Skip to content

Commit 77a25ad

Browse files
committed
Add banner image to readme and update why section [ci skip]
1 parent 760e696 commit 77a25ad

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# React Redux Boilerplate
1+
<img src="https://raw.githubusercontent.com/flexdinesh/react-redux-boilerplate/master/app/components/Header/images/banner.jpg" alt="react redux boilerplate banner" align="center" />
22

3-
<div align="center">A minimal React-Redux boilerplate with all the best practices</div>
3+
<br />
4+
5+
<div align="center">A minimal, beginner friendly React-Redux boilerplate with all the industry best practices</div>
46

57
<br />
68

@@ -17,8 +19,6 @@
1719
<a href="https://travis-ci.org/flexdinesh/react-redux-boilerplate">
1820
<img src="https://travis-ci.org/flexdinesh/react-redux-boilerplate.svg" alt="Build Status" />
1921
</a>
20-
</div>
21-
<div align="center">
2222
<!-- Gitter -->
2323
<a href="https://gitter.im/flexdinesh/react-redux-boilerplate">
2424
<img src="https://camo.githubusercontent.com/54dc79dc7da6b76b17bc8013342da9b4266d993c/68747470733a2f2f6261646765732e6769747465722e696d2f6d78737462722f72656163742d626f696c6572706c6174652e737667" alt="Gitter Chat" />
@@ -31,21 +31,34 @@
3131
<sub>Created by <a href="https://twitter.com/flexdinesh">Dinesh Pandiyan</a></sub>
3232
</div>
3333

34+
35+
## Why? [![start with why](https://img.shields.io/badge/start%20with-why%3F-brightgreen.svg?style=flat)](http://www.ted.com/talks/simon_sinek_how_great_leaders_inspire_action)
36+
37+
The whole react community knows and will unanimously agree that [react-boilerplate](https://github.com/react-boilerplate/react-boilerplate) is the ultimate starter template for kickstarting any React project. It's setup with all the industry best practices and standards. But it also has a lot more than what you just need to start a react-redux app. It took me quite some time to get my head around what was happening in the codebase and it's clearly not for beginners. They quote this right in their readme,
38+
39+
> Please note that this boilerplate is **production-ready and not meant for beginners**! If you're just starting out with react or redux, please refer to https://github.com/petehunt/react-howto instead. If you want a solid, battle-tested base to build your next product upon and have some experience with react, this is the perfect start for you.
40+
41+
So it involves a lot of additional learning curve to get started with [react-boilerplate](https://github.com/react-boilerplate/react-boilerplate). That's why I stripped it down and made this _leaner, **beginner friendly**_ boilerplate without all the additional complexity.
42+
43+
3444
## Features
3545

3646
<dl>
3747
<dt>Instant feedback</dt>
3848
<dd>Enjoy the best DX (Developer eXperience) and code your app at the speed of thought! Your saved changes to the CSS and JS are reflected instantaneously without refreshing the page. Preserve application state even when you update something in the underlying code!</dd>
3949

40-
<dt>Predictable state management</dt>
41-
<dd>Unidirectional data flow allows for change logging and time travel debugging.</dd>
42-
4350
<dt>Next generation JavaScript</dt>
4451
<dd>Use template strings, object destructuring, arrow functions, JSX syntax and more, today.</dd>
4552

53+
<dt>Component Specific Styles</dt>
54+
<dd>Separate styles for each component. Style in the good old scss way but still keep it abstracted for each component.</dd>
55+
4656
<dt>Industry-standard routing</dt>
4757
<dd>It's natural to want to add pages (e.g. `/about`) to your application, and routing makes this possible.</dd>
4858

59+
<dt>Predictable state management</dt>
60+
<dd>Unidirectional data flow allows for change logging and time travel debugging.</dd>
61+
4962
<dt>SEO</dt>
5063
<dd>We support SEO (document head tags management) for search engines that support indexing of JavaScript content. (eg. Google)</dd>
5164
</dl>

0 commit comments

Comments
 (0)