README for 8.x-1.x branch

Looks good except for:

1. +++ b/README.txt
   @@ -0,0 +1,72 @@
   +local machine. It will just serve a 301 (permanent URL redirection) and create a link to the original file on the remote server. ¶
   

   special character at the end of the sentence needs to be removed.

2. +++ b/README.txt
   @@ -0,0 +1,72 @@
   +By default, this variable is set to TRUE.  ¶
   

   Special character and extra space at the end of this line should be removed.

Regards,
Jeff

Looks good :)

Drupal 8 doesn't support variable_set and $conf variables as described here. Apologies if I'm missing something, but this Readme seems applicable to 7.x, not 8.x.

I might encourage the OP to do a bit more diligence when creating READMEs. Quality over quantity! https://www.drupal.org/user/3332522/track/code

The 8.x configuration is already thoroughly documented by the maintainers in the existing INSTALL.txt file. So, per module documentation guidelines, I feel it can remain there and the README can provide the "basic overview of what the module does and how someone may use it".

The patch attached does that, and moves the INSTALL.txt file to a INSTALL.md file.

Sounds good to me :) I wonder what you all think about wrapping consistency? Here's my thoughts:

1. +++ b/README.md
   @@ -0,0 +1,58 @@
   +The Stage File Proxy module saves you time and disk space by sending requests to your development environment's files directory to the production environment and making a copy of the production file in your development site. It makes it
   

   Some lines break at 80 characters and some don't. Probably best to keep it consistent. Since it's not code, it's ok to extend beyond the 80 character mark but it seems fine to restrict all lines too.

2. +++ b/README.md
   @@ -0,0 +1,58 @@
   +Install the Stage File Proxy module as you would normally install a contributed Drupal module. Visit https://www.drupal.org/node/1897420 for more information.
   

   Same as above, this line goes beyond the 80 char mark whereas other lines are wrapped at 80 chars.

3. +++ b/README.md
   @@ -0,0 +1,58 @@
   + to configure this within your settings.php or settings.local.php file. Detailed
   + descriptions of each setting, and syntax for defining the configuration in code
   + is in INSTALL.md
   

   When wrapping text, there shouldn't be a space before the wrapped lines.

Regards,
Jeff

Thanks all! I fixed the wrapping issues when committing it.