commit c2e7c68b337856fb954887bffc0f6703d5e56c53
parent 0d01779c3df27d887e05cb50b5335c08e0de90b8
Author: Konstantin Tarkus <hello@tarkus.me>
Date: Mon, 11 Apr 2016 17:57:21 +0300
Add Backers section to README.md
Diffstat:
| M | README.md | | | 87 | ++++++++++++++++++++++++++++++++++--------------------------------------------- |
| M | docs/getting-started.md | | | 37 | +++++++++++++++++++++++++++++++++++++ |
2 files changed, 74 insertions(+), 50 deletions(-)
diff --git a/README.md b/README.md
@@ -1,22 +1,20 @@
## React Starter Kit — "isomorphic" web app boilerplate
-[](https://salt.bountysource.com/teams/react-starter-kit)<br>
-
> [React Starter Kit](https://www.reactstarterkit.com) is an opinionated
-> boilerplate for web development built on top of Facebook's
-> [React](https://facebook.github.io/react/) library,
-> [Node.js](https://nodejs.org/) / [Express](http://expressjs.com/) server
-> and [Flux](http://facebook.github.io/flux/) architecture. Containing
-> modern web development tools such as [Webpack](http://webpack.github.io/),
-> [Babel](http://babeljs.io/) and [BrowserSync](http://www.browsersync.io/).
-> Helping you to stay productive following the best practices. A solid starting
-> point for both professionals and newcomers to the industry.
-
-See [demo](http://demo.reactstarterkit.com) |
+> boilerplate for web development built on top of [Node.js](https://nodejs.org/),
+> [Express](http://expressjs.com/), [GraphQL](http://graphql.org/) and
+> [React](https://facebook.github.io/react/). Containing modern web development
+> tools such as [Webpack](http://webpack.github.io/), [Babel](http://babeljs.io/)
+> and [BrowserSync](http://www.browsersync.io/). Helping you to stay productive
+> following the best practices. A solid starting point for both professionals
+> and newcomers to the industry.
+
+See [homepage](https://www.reactstarterkit.com) |
+[demo](http://demo.reactstarterkit.com) |
[docs](https://github.com/kriasoft/react-starter-kit/tree/master/docs) |
[to-do list](https://waffle.io/kriasoft/react-starter-kit) |
-join [#react-starter-kit](https://gitter.im/kriasoft/react-starter-kit) chatroom to stay up to date |
-visit our sponsors:
+join [#react-starter-kit](https://gitter.im/kriasoft/react-starter-kit) chat room to stay up to date |
+visit our sponsors:<br><br>
[](https://rollbar.com/?utm_source=reactstartkit(github)&utm_medium=link&utm_campaign=reactstartkit(github))
[](https://localizejs.com/?cid=802&utm_source=rsk)
@@ -26,42 +24,31 @@ visit our sponsors:
* Follow the [getting started guide](./docs/getting-started.md) to download and run the project
* Check the [code recipes](./docs/recipes) used in this boilerplate, or share yours
-### Directory Layout
-
-```
-.
-├── /build/ # The folder for compiled output
-├── /docs/ # Documentation files for the project
-├── /node_modules/ # 3rd-party libraries and utilities
-├── /src/ # The source code of the application
-│ ├── /actions/ # Action creators that allow to trigger a dispatch to stores
-│ ├── /components/ # React components
-│ ├── /constants/ # Constants (action types etc.)
-│ ├── /content/ # Static content (plain HTML or Markdown, Jade, you name it)
-│ ├── /core/ # Core framework and utility functions
-│ ├── /data/ # GraphQL server schema
-│ ├── /decorators/ # Higher-order React components
-│ ├── /public/ # Static files which are copied into the /build/public folder
-│ ├── /routes/ # Page/screen components along with the routing information
-│ ├── /stores/ # Stores contain the application state and logic
-│ ├── /views/ # Express.js views for index and error pages
-│ ├── /client.js # Client-side startup script
-│ ├── /config.js # Global application settings
-│ ├── /routes.js # Universal (isomorphic) application routes
-│ └── /server.js # Server-side startup script
-├── /tools/ # Build automation scripts and utilities
-│ ├── /lib/ # Library for utility snippets
-│ ├── /build.js # Builds the project from source to output (build) folder
-│ ├── /bundle.js # Bundles the web resources into package(s) through Webpack
-│ ├── /clean.js # Cleans up the output (build) folder
-│ ├── /copy.js # Copies static files to output (build) folder
-│ ├── /deploy.js # Deploys your web application
-│ ├── /run.js # Helper function for running build automation tasks
-│ ├── /runServer.js # Launches (or restarts) Node.js server
-│ ├── /start.js # Launches the development web server with "live reload"
-│ └── /webpack.config.js # Configurations for client-side and server-side bundles
-└── package.json # The list of 3rd party libraries and utilities
-```
+### Backers
+
+♥ Universal Router? Help us keep it alive by [donating funds](https://salt.bountysource.com/teams/react-starter-kit) to cover project expenses!
+
+<a href="http://www.nekst.me/" target="_blank" title="lehneres">
+ <img src="https://github.com/lehneres.png?size=64" width="64" height="64" alt="lehneres">
+</a>
+<a href="http://www.vidpanel.com/" target="_blank" title="Tarkan Anlar">
+ <img src="https://github.com/tarkanlar.png?size=64" width="64" height="64" alt="Tarkan Anlar">
+</a>
+<a href="https://morten.olsen.io/" target="_blank" title="Morten Olsen">
+ <img src="https://github.com/mortenolsendk.png?size=64" width="64" height="64" alt="Morten Olsen">
+</a>
+<a href="https://twitter.com/adamthomann" target="_blank" title="Adam">
+ <img src="https://github.com/athomann.png?size=64" width="64" height="64" alt="Adam">
+</a>
+<a href="http://dsernst.com/" target="_blank" title="David Ernst">
+ <img src="https://github.com/dsernst.png?size=64" width="64" height="64" alt="David Ernst">
+</a>
+<a href="http://zanehitchcox.com/" target="_blank" title="Zane Hitchcox">
+ <img src="https://github.com/zwhitchcox.png?size=64" width="64" height="64" alt="Zane Hitchcox">
+</a>
+<a href="https://salt.bountysource.com/teams/react-starter-kit" target="_blank">
+ <img src="https://opencollective.com/static/images/become_backer.svg" width="64" height="64" alt="">
+</a>
### Related Projects
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -1,5 +1,42 @@
## Getting Started
+### Directory Layout
+
+```
+.
+├── /build/ # The folder for compiled output
+├── /docs/ # Documentation files for the project
+├── /node_modules/ # 3rd-party libraries and utilities
+├── /src/ # The source code of the application
+│ ├── /actions/ # Action creators that allow to trigger a dispatch to stores
+│ ├── /components/ # React components
+│ ├── /constants/ # Constants (action types etc.)
+│ ├── /content/ # Static content (plain HTML or Markdown, Jade, you name it)
+│ ├── /core/ # Core framework and utility functions
+│ ├── /data/ # GraphQL server schema
+│ ├── /decorators/ # Higher-order React components
+│ ├── /public/ # Static files which are copied into the /build/public folder
+│ ├── /routes/ # Page/screen components along with the routing information
+│ ├── /stores/ # Stores contain the application state and logic
+│ ├── /views/ # Express.js views for index and error pages
+│ ├── /client.js # Client-side startup script
+│ ├── /config.js # Global application settings
+│ ├── /routes.js # Universal (isomorphic) application routes
+│ └── /server.js # Server-side startup script
+├── /tools/ # Build automation scripts and utilities
+│ ├── /lib/ # Library for utility snippets
+│ ├── /build.js # Builds the project from source to output (build) folder
+│ ├── /bundle.js # Bundles the web resources into package(s) through Webpack
+│ ├── /clean.js # Cleans up the output (build) folder
+│ ├── /copy.js # Copies static files to output (build) folder
+│ ├── /deploy.js # Deploys your web application
+│ ├── /run.js # Helper function for running build automation tasks
+│ ├── /runServer.js # Launches (or restarts) Node.js server
+│ ├── /start.js # Launches the development web server with "live reload"
+│ └── /webpack.config.js # Configurations for client-side and server-side bundles
+└── package.json # The list of 3rd party libraries and utilities
+```
+
### Requirements
* Mac OS X, Windows, or Linux
