Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update README.md

changed a few grammar and spelling issues in README.md
  • Loading branch information...
commit 80db08f36815050559527755010fd7b24e65c05f 1 parent ac04c60
@dmh2000 dmh2000 authored
Showing with 15 additions and 15 deletions.
  1. +15 −15 README.md
View
30 README.md
@@ -37,12 +37,12 @@ static assets to a separate server in order to get them cached.
#### Set caching headers for files
In order to reduce the amount of HTTP requests that a browser would do for your
-files it's automatically setting the appropriate caching headers. This way you
+files, versions automatically sets the appropriate caching headers. This way you
assets will be served from the browser cache instead of the server.
#### Advanced gzipping
-Gzip is enabled on every compatible file format. Even if the origin server
+Gzip is enabled on every compatible file format, even if the origin server
doesn't support gzip. In addition to that, we have disabled gzip for IE 5 and
IE6 without service pack 2 as it's known to impropperly cache it. We also have
detection for obfuscated gzip headers as researched by the [Yahoo performance
@@ -117,7 +117,7 @@ using the API to override some of the configuration values.
<dt>blacklisted extensions</dt>
<dd>
<p>
- Black list extensions that you do want to have pulled from your origin
+ Black list extensions that you do not want to have pulled from your origin
server. You can for example black list <code>.conf</code> files or maybe
some other random files. Please note that people can still fetch these
files directly from the origin server.
@@ -130,7 +130,7 @@ using the API to override some of the configuration values.
<dd>
<p>
Set custom <code>Access-Control-Allow-Origin</code> headers. The default
- value is <code>*</code> so all values are allowed. If you only want allow
+ value is <code>*</code> so all values are allowed. If you only want to allow
access from a specific domain set the domain here.
</p>
@@ -140,9 +140,9 @@ using the API to override some of the configuration values.
<dt>directory</dt>
<dd>
<p>
- A directory that is relative the module that required versions that is
+ A directory that is relative to the module that required versions that is
used to serve static content. If you want this directory to be relative to
- a different path. You can see a <code>root</code> property.
+ a different path. You can set a <code>root</code> property.
</p>
<pre>versions.set('directory', './public');</pre>
@@ -184,8 +184,8 @@ using the API to override some of the configuration values.
<dt>origin servers</dt>
<dd>
<p>
- An array of of servers objects that is used to fetch resources from that
- is not found in the <code>directory</code> property.
+ An array of of server objects that is used to fetch resources from that
+ are not found in the <code>directory</code> property.
</p>
<pre>versions.set('origin servers', { url: "http://example.com", name: "foo" });</pre>
@@ -205,8 +205,8 @@ using the API to override some of the configuration values.
<dt>aliases</dt>
<dd>
<p>
- In order to parallize the downloading of assets in the browser it's should
- be spread accross multiple subdomains/domains. You can supply origins
+ In order to parallize the downloading of assets in the browser they should
+ be spread accross multiple subdomains/domains. You can supply
multiple origin servers that the client will use to distribute the assets.
</p>
@@ -216,7 +216,7 @@ using the API to override some of the configuration values.
<dt>log level</dt>
<dd>
<p>
- As versions is inteded to ran as stand alone server it comes with a logger
+ As versions is inteded to run as a stand alone server it comes with a logger
that outputs some useful information. You can control the amount of output
by changing the log level. The default value is log. Please check the
<a href="http://github.com/observing/devnull#logging-methods-and-levels">dev/null node.js logger</a>
@@ -229,9 +229,9 @@ using the API to override some of the configuration values.
<dt>plugins</dt>
<dd>
<p>
- Versions is build ontop of the connect framework is configured to use the
+ Versions is build on top of the connect framework and is configured to use the
minimal amount of plugins to get the job done. The plugins array allows
- you to specify extra middleware layers that you want to have loaded in to
+ you to specify extra middleware layers that you want to have loaded into
versions or custom connect compatible nodejs modules that need to be
required.
</p>
@@ -242,7 +242,7 @@ using the API to override some of the configuration values.
<dt>sync</dt>
<dd>
<p>
- Syncronise configuration between client and server. If you are using
+ Synchronise configuration between client and server. If you are using
multiple servers also set the redis configuration.
</p>
@@ -312,7 +312,7 @@ this as default configuration.
### Configuration API
-In addition to reading your `versions.json` file for the configuration it's also
+In addition to reading your `versions.json` file for the configuration it is also
possible to set the configuration using dedicated API methods or the
`versions#set` method. The `versions#set` method expects 2 arguments, the first
argument is the name of the configuration key that you want to update and the
Please sign in to comment.
Something went wrong with that request. Please try again.