ff-stream-web

commit cd8225f3ad81dab0eaf7ad740328e9bdd30afa21
parent 2fa57d86e10824077321b34cbd55f8d35a12066f
Author: Konstantin Tarkus <hello@tarkus.me>
Date:   Wed, 15 Oct 2014 13:43:28 +0400

Update README.md

Diffstat:
M
README.md
 | 
38
+++++++++++++++++++-------------------

1 file changed, 19 insertions(+), 19 deletions(-)
diff --git a/README.md b/README.md
@@ -6,10 +6,11 @@
 [![Tips](http://img.shields.io/gratipay/koistya.svg?style=flat)](https://gratipay.com/koistya)
 [![Gitter](http://img.shields.io/badge/chat-online-brightgreen.svg?style=flat)](https://gitter.im/kriasoft/react-starter-kit)
 
-> This project template is a skeleton for a typical web application or single-page
-> application (SPA) based on [Facebook React](https://facebook.github.io/react/).
-> You can use it to quickly bootstrap your web application projects. It contains
-> only client-side components and development tools and is recommended to be paired
+> This project template is a skeleton for an [isomorphic](http://nerds.airbnb.com/isomorphic-javascript-future-web-apps/)
+> web application (SPA) based on Facebook's [React](https://facebook.github.io/react/)
+> library and [Flux](http://facebook.github.io/flux/) architecture. You can use
+> it to quickly bootstrap your web application projects. It contains only
+> client-side components and development tools and is recommended to be paired
 > with a server-side project similar to [ASP.NET Web Application Starter Kit](https://github.com/kriasoft/AspNet-Server-Template).
 
 [![Facebook React Starter Kit](https://dl.dropboxusercontent.com/u/16006521/Screens/facebook-react-starter-kit.png)](https://github.com/kriasoft/react-starter-kit)
@@ -22,25 +23,25 @@
 .
 ├── /build/                     # The folder for compiled output
 ├── /config/                    # Configuration files for Webpack, Jest etc.
-├── /docs/                      # Documentation files
-├── /node_modules/              # Node.js-based dev tools and utilities
+├── /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
-│   ├── /assets/                # Static files which don't require pre-processing
-│   ├── /constants/             # Enumerations used in action methods and stores
-│   ├── /components/            # React components. E.g. Navbar.jsx
+│   ├── /assets/                # Static files which are copied to ./build on compile
+│   ├── /constants/             # Enumerations used in action creators and stores
+│   ├── /components/            # React components. E.g. Navbar.jsx, Calendar.jsx
 │   ├── /images/                # Graphics (.png, .jpg, .svg etc.)
-│   ├── /layouts/               # Layouts for web pages
-│   ├── /pages/                 # Web pages. E.g. Profile.jsx (or .html, .jade etc.)
+│   ├── /layouts/               # Shared layouts for top-level components
+│   ├── /pages/                 # Top-level, URL-bound React components
 │   ├── /stores/                # Stores contain the application state and logic
-│   ├── /styles/                # LESS style sheets (or SASS/SCSS, Stylus etc.)
-│   ├── /app.js                 # Entry point of your web application
-│   └── /AppDispatcher.js       # The central hub that manages all data flow
+│   ├── /styles/                # CSS style sheets (or LESS, SASS, Stylus)
+│   ├── /app.js                 # The application's bootstrap file, entry point
+│   └── /AppDispatcher.js       # The central hub that manages all data flow (see Flux)
 ├── /test/                      # Unit, integration and load tests
 │   ├── /e2e/                   # End-to-end tests
 │   └── /unit/                  # Unit tests
 │── gulpfile.js                 # Configuration file for automated builds
-└── package.json                # The list of 3rd party libraries and tools
+└── package.json                # The list of 3rd party libraries and utilities
 ```
 
 ### Getting Started
@@ -70,7 +71,7 @@ $ gulp                          # or, `gulp --release`
 ```
 
 This will start a lightweight development server with LiveReload and
-synchronized browsing support across multiple devices and browsers.
+synchronized browsing across multiple devices and browsers.
 
 ### How to Deploy
 
@@ -115,12 +116,11 @@ $ npm test
 
 ### Support
 
-Have questions, feedback or need help? Contact [support@kriasoft.com](mailto:support@kriasoft.com)
-or schedule a mentoring session on [codementor.io/koistya](https://www.codementor.io/koistya).
+Have feedback, feature request or need help? Contact me on [codementor.io/koistya](https://www.codementor.io/koistya).
 
 ### Copyright
 
-Source code is licensed under the MIT License. See [LICENSE.txt](./LICENSE.txt)
+Source code is licensed under the MIT License (MIT). See [LICENSE.txt](./LICENSE.txt)
 file in the project root. Documentation to the project is licensed under the
 [CC BY 4.0](http://creativecommons.org/licenses/by/4.0/) license. React logo
 image is a trademark of Facebook, Inc.