Respec Uppercase for Readmes

.github/CONTRIBUTING.md

@@ -5,7 +5,7 @@
 - Please search the existing issues first, it's likely that your issue was already reported or even fixed.
   - Go to "Issues" and type any word in the top search/command bar.
   - Consider to search on closed issues. To do that just remove "is:open" from the search field.
-  - More info on [search syntax within github](https://help.github.com/articles/searching-issues)
+  - More info on [search syntax within github](https://help.github.com/articles/searching-issues).
 - Report the issue using our [template](https://github.com/saenzramiro/rambox/blob/master/.github/ISSUE_TEMPLATE.md), it includes all the information we need to track down the issue.
 
 Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues.
@@ -16,7 +16,7 @@ If you consider there are other users that can use your Custom Service, we have
 
 ## Ask for help
 
-We have a great community in [Gitter](https://gitter.im/saenzramiro/rambox) (Gitter channel is mirroring into Slack general room) or [Slack](https://rambox.typeform.com/to/t7jc4C) that can help you with any doubt or problem.
+We have a great community in [Slack (Prefered)](https://rambox.typeform.com/to/t7jc4C) or [Gitter](https://gitter.im/saenzramiro/rambox) (Gitter channel is mirroring into Slack `general` room) that can help you with any doubt or problem.
 
 ## Contributing to Source Code
 

CONTRIBUTING.md

@@ -10,7 +10,7 @@ Working on your first Pull Request? You can learn how from this *free* series [H
 
 ##### If you've found a bug that is not on the board, [follow these steps](README.md#found-a-bug).
 
---------------------------------------------------------------------------------
+---
 
 ## Contribution Guidelines
 
@@ -73,10 +73,7 @@ If your versions are lower than the prerequisite versions, you should update.
 
 1. Open a Terminal / Command Line / Bash Shell in your projects directory (_i.e.: `/yourprojectdirectory/`_)
 1. Clone your fork of rambox
-
+    - `git clone https://github.com/yourUsername/rambox.git`
-```shell
-git clone https://github.com/yourUsername/rambox.git
-```
 
 **(make sure to replace `yourUsername` with your GitHub username)**
 
@@ -86,12 +83,9 @@ This will download the entire rambox repo to your projects directory.
 
 1. Change directory to the new rambox directory (`cd rambox`)
 1. Add a remote to the official rambox repo:
+    - `git remote add upstream https://github.com/saenzramiro/rambox.git`
 
-```shell
+Congratulations, you now have a local copy of the rambox repo! :tada:
-git remote add upstream https://github.com/saenzramiro/rambox.git
-```
-
-Congratulations, you now have a local copy of the rambox repo!
 
 ### Create a Branch
 
@@ -164,9 +158,7 @@ Always feel free to reach out to the chat room when you are not certain of any t
 #### Adding or Editing Services
 
 The services are stored inside the file `./app/store/ServicesList.js`.  Add your service to the *BOTTOM* of the array.
-
 The logo it's referencing is located in `./resources/icons/`.
-
 To see these changes you'll need to stop your `npm start` and `sencha app watch`, and then rerun those.
 
 ### Creating a Pull Request
@@ -230,8 +222,8 @@ Don't despair! You should receive solid feedback as to why it was rejected and w
 Many Pull Requests, especially first Pull Requests, require correction or updating.
 If you have used the GitHub interface to create your PR, you will need to close your PR, create a new branch, and re-submit.
 
-If you have a local copy of the repo, you can make the requested changes and amend your commit with: `git commit --amend` This will update your existing
+If you have a local copy of the repo, you can make the requested changes and amend your commit with: `git commit --amend`
-commit.
+This will update your existing commit.
 When you push it to your fork you will need to do a force push to overwrite your old commit: `git push --force`
 
 Be sure to post in the PR conversation that you have made the requested changes.

app/Readme.md

@@ -1,8 +1,8 @@
 # ./controller
 
-This folder contains the application's global controllers. ViewControllers are located
+This folder contains the application's global controllers.
-alongside their respective view class in `./view`. These controllers are used for routing
+ViewControllers are located alongside their respective view class in `./view`.
-and other activities that span all views.
+These controllers are used for routing and other activities that span all views.
 
 # ./model
 
@@ -10,10 +10,9 @@ This folder contains the application's (data) Model classes.
 
 # ./view
 
-This folder contains the views as well as ViewModels and ViewControllers depending on the
+This folder contains the views as well as ViewModels and ViewControllers depending on the application's architecture.
-application's architecture. Pure MVC applications may not have ViewModels, for example. For
+Pure MVC applications may not have ViewModels, for example.
-MVCVM applications or MVC applications that use ViewControllers, the following directory
+For MVCVM applications or MVC applications that use ViewControllers, the following directory structure is recommended:
-structure is recommended:
 
 ```text
 ./view/
@@ -23,10 +22,8 @@ structure is recommended:
         FooModel.js         # The ViewModel for Foo
 ```
 
-This structure helps keep these closely related classes together and easily identifiable in
+This structure helps keep these closely related classes together and easily identifiable in most tabbed IDE's or text editors.
-most tabbed IDE's or text editors.
 
 # ./store
 
-This folder contains any number of store instances or types that can then be reused in the
+This folder contains any number of store instances or types that can then be reused in the application.
-application.

app/model/Readme.md

@@ -1,28 +1,29 @@
-## Adding a service
+# Adding a service
+
+The available services are stored in the [ServicesList.js](../store/ServicesList.js).
 
-The available services are stored in the [ServiceList.js](app/store/ServicesList.js).
 Structure of a service entry:
 
-|Name|Description|Required|
+| Name                          | Description                                                                                                                                  | Required |
-|---|---|---|
+| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
-|id|Unique identifier for the service, e.g. "slack"|yes|
+| id                            | Unique identifier for the service, e.g. "**slack**"                                                                                          | yes      |
-|logo|File name of the service logo located in "/resources/icons/", e.g. "slack.png"|yes|
+| logo                          | File name of the service logo located in `/resources/icons/`, e.g. "**slack.png**"                                                           | yes      |
-|name|Visible name for the service, e.g. "Slack"|yes|
+| name                          | Visible name for the service, e.g. "**Slack**"                                                                                               | yes      |
-|description|A short description of the service, e.g. "Slack brings all your communication together..."|yes|
+| description                   | A short description of the service, e.g. "**Slack brings all your communication together...**"                                               | yes      |
-|url|URL of the service, e.g. "https://\_\_\_.slack.com/". "\_\_\_" may be used as a placeholder, that can be configured when adding a service.|yes|
+| url                           | URL of the service, e.g. "<https://\_\_\_.slack.com/>". "\_\_\_" may be used as a placeholder, that can be configured when adding a service. | yes      |
-|type|Defines the type of the service. Must be one of `email` or `messaging`.|yes|
+| type                          | Defines the type of the service. Must be one of `email` or `messaging`.                                                                      | yes      |
-|allow_popups|Set to `true` to allow popup windows for the service.|no|
+| allow_popups                  | Set to `true` to allow popup windows for the service.                                                                                        | no       |
-|note|Additional info to display when adding the service.|no|
+| note                          | Additional info to display when adding the service.                                                                                          | no       |
-|manual_notifications|Set to `true` to let Rambox trigger notifications. Can be used for services that doesn't support browser notifications.|no|
+| manual_notifications          | Set to `true` to let Rambox trigger notifications. Can be used for services that doesn't support browser notifications.                      | no       |
-|js_unread|JavaScript code for setting the unread count (see below).|no|
+| js_unread                     | JavaScript code for setting the unread count (see below).                                                                                    | no       |
-|dont_update_unread_from_title|Set to `true` to prevent updating the unread count from the window title (see below).|no|
+| dont_update_unread_from_title | Set to `true` to prevent updating the unread count from the window title (see below).                                                        | no       |
 
-### Setting the unread count
+## Setting the unread count
 
-While there is also a way to set the unread count by adding ` (COUNT)` to the window title, this describes the preferred way of doing it:
+While there is also a way to set the unread count by adding `(COUNT)` to the window title, this describes the preferred way of doing it:
 
 First set `dont_update_unread_from_title` in the service config to `true`.
 
 Code provided by `js_unread` will be injected into the service website.
 You can retrieve the unread count in this JavaScript code e.g. by parsing elements.
-Set the unread count by calling `rambox.setUnreadCount(COUNT)` or clear it by calling `rambox.clearUnreadCount()`. 
+Set the unread count by calling `rambox.setUnreadCount(COUNT)` or clear it by calling `rambox.clearUnreadCount()`.

ext/packages/ext-aria/build/resources/Readme.md

@@ -1,3 +1,3 @@
 # ext-aria/resources
 
-This folder contains static resources (typically an `"images"` folder as well).
+This folder contains static resources (typically an `images` folder as well).

ext/packages/ext-aria/resources/Readme.md

@@ -1,3 +1,3 @@
 # ext-aria/resources
 
-This folder contains static resources (typically an `"images"` folder as well).
+This folder contains static resources (typically an `images` folder as well).

ext/packages/ext-aria/sass/etc/Readme.md

@@ -1,4 +1,4 @@
 # ext-aria/sass/etc
 
-This folder contains miscellaneous SASS files. Unlike `"ext-aria/sass/etc"`, these files
+This folder contains miscellaneous SASS files.
-need to be used explicitly.
+Unlike `ext-aria/sass/etc`, these files need to be used explicitly.

ext/packages/sencha-soap/Readme.md

@@ -1,2 +1 @@
 # sencha-soap - Read Me
-

packages/local/rambox-default-theme/Readme.md

@@ -1,2 +1 @@
 # rambox-default-theme - Read Me
-

packages/local/rambox-default-theme/examples/Readme.md

@@ -1,38 +1,45 @@
 # rambox-default-theme/examples
 
-This folder contains example applications demonstrating this package. Each of
+This folder contains example applications demonstrating this package.
-these applications will be built as part of the package build:
+Each of these applications will be built as part of the package build:
 
-    cd /path/to/package
+```bash
-    sencha package build
+cd /path/to/package
+sencha package build
+```
 
 As applications, they can also be built individually:
 
-    cd /path/to/package/examples/example-app
+```bash
-    sencha app build
+cd /path/to/package/examples/example-app
+sencha app build
+```
 
 Or you can build all examples as a group:
 
-    cd /path/to/package
+```bash
-    sencha ant examples
+cd /path/to/package
+sencha ant examples
+```
 
 The ideal location for the example builds to reside is the `"./build"` folder:
 
-    /path/to/package/
+```text
-        src/
+/path/to/package/
-        resources/
+    src/
+    resources/
+        ...
+    examples/
+        example-app/
+        other-example/
         ...
+    build/
+        resources/
         examples/
             example-app/
             other-example/
-        ...
+```
-        build/
-            resources/
-            examples/
-                example-app/
-                other-example/
 
-This can be specified in the `".sencha/app/build.properties"` file for the
+This can be specified in the `".sencha/app/build.properties"` file for the example applications:
-example applications:
 
-    build.dir=${package.build.dir}/examples/${app.name}
+`build.dir=${package.build.dir}/examples/${app.name}`

packages/local/rambox-default-theme/sass/Readme.md

@@ -2,6 +2,8 @@
 
 This folder contains SASS files of various kinds, organized in sub-folders:
 
-    rambox-default-theme/sass/etc
+```text
-    rambox-default-theme/sass/src
+rambox-default-theme/sass/etc
-    rambox-default-theme/sass/var
+rambox-default-theme/sass/src
+rambox-default-theme/sass/var
+```

packages/local/rambox-default-theme/sass/etc/Readme.md

@@ -1,4 +1,4 @@
 # rambox-default-theme/sass/etc
 
-This folder contains miscellaneous SASS files. Unlike `"rambox-default-theme/sass/etc"`, these files
+This folder contains miscellaneous SASS files.
-need to be used explicitly.
+Unlike `"rambox-default-theme/sass/etc"`, these files need to be used explicitly.

packages/local/rambox-default-theme/sass/src/Readme.md

@@ -1,4 +1,4 @@
 # rambox-default-theme/sass/src
 
-This folder contains SASS sources that mimic the component-class hierarchy. These files
+This folder contains SASS sources that mimic the component-class hierarchy.
-are gathered in to a build of the CSS based on classes that are used by the build.
+These files are gathered in to a build of the CSS based on classes that are used by the build.

packages/local/rambox-default-theme/src/Readme.md

@@ -1,4 +1,3 @@
 # rambox-default-theme/src
 
-This folder contains source code that will automatically be added to the classpath when
+This folder contains source code that will automatically be added to the classpath when the package is used.
-the package is used.

resources/Readme.md

@@ -1,4 +0,0 @@
-# Rambox/resources
-
-This folder contains resources (such as images) needed by the application. This file can
-be removed if not needed.

sass/Readme.md

@@ -4,41 +4,36 @@ This folder contains the styling for the application's views. The primary pi
 
 ## Styling
 
-Sencha Cmd supports styling using Sass and integrates the styling from the theme
+Sencha Cmd supports styling using Sass and integrates the styling from the theme and required packages (specified in `app.json`) with application-defined views.
-and required packages (specified in `"app.json"`) with application-defined views.
 
 ### ./sass/etc
 
-This folder contains misc. support code for Sass builds (global functions, 
+This folder contains misc. support code for Sass builds (global functions, mixins, etc.).
-mixins, etc.).
 
 ### ./sass/src
 
 This folder contains Sass files defining CSS rules corresponding to classes
-included in the application's JavaScript code build. By default, files in this 
+included in the application's JavaScript code build. By default, files in this
 folder are mapped to the application's root namespace, 'Rambox'. This is set in
-`"app.json"`:
+`app.json`:
 
-    "sass": {
+```json
-        "namespace": "Rambox"
+"sass": {
-    }
+    "namespace": "Rambox"
+}
+```
 
 ### ./sass/var
 
-This folder contains Sass files defining Sass variables corresponding to classes
+This folder contains Sass files defining Sass variables corresponding to classes included in the application's JavaScript code build.
-included in the application's JavaScript code build. By default, files in this 
+By default, files in this folder are mapped to the application's root namespace, 'Rambox' in the same way as `Rambox/sass/src`.
-folder are mapped to the application's root namespace, 'Rambox' in the same way
-as `"Rambox/sass/src"`.
 
 ## Slicing
 
-Internet Explorer 8 and 9 do not support linear gradients and IE8 does not support
+Internet Explorer 8 and 9 do not support linear gradients and IE8 does not support border-radius.
-border-radius. To compensate for this, Sencha Cmd provides "image slicing" using an
+To compensate for this, Sencha Cmd provides "image slicing" using an internal WebKit based renderer.
-internal WebKit based renderer. To enable this, there is a special web page that
+To enable this, there is a special web page that renders all components and states so they can be captured and turned into image sprites.
-renders all components and states so they can be captured and turned into image
-sprites.
 
 ### ./sass/example
 
-This folder contains the web page used to present all components and states so they
+This folder contains the web page used to present all components and states so they can be captured as an image and used to produce images for IE8 and 9.
-can be captured as an image and used to produce images for IE8 and 9.