Permalink
Browse files

Merge pull request #14 from dmh2000/master

updates to README.md
  • Loading branch information...
2 parents ac04c60 + 15d82d9 commit a04cff75c950380414d4c90132e141b9cae2dcd0 @3rd-Eden committed Mar 8, 2013
Showing with 21 additions and 21 deletions.
  1. +21 −21 README.md
View
@@ -37,14 +37,14 @@ 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
+IE6 without service pack 2 as it is known to improperly cache it. We also have
detection for obfuscated gzip headers as researched by the [Yahoo performance
team](http://developer.yahoo.com/blogs/ydn/posts/2010/12/pushing-beyond-gzipping/).
@@ -56,7 +56,7 @@ endless.
#### Metrics
-Everybody loves stats, thats why we are gathering metrics about the requests and
+Everybody loves stats, that's why we are gathering metrics about the requests and
the state of the server. These metrics can be accessed through the REST API.
#### Client API
@@ -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>
@@ -152,7 +152,7 @@ using the API to override some of the configuration values.
<dd>
<p>
How long should we keep items in our internal (memory) cache. It accepts a
- numeric value as miliseconds or a human readable string like
+ numeric value as milliseconds or a human readable string like
<code>10 hours</code> or <code>90 minutes</code>. Defaults to 1 hour.
</p>
@@ -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 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 parallelize the downloading of assets in the browser they should
+ be spread across 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 intended to run as a standalone 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 built 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>
@@ -271,7 +271,7 @@ using the API to override some of the configuration values.
Optional auth/password to access your redis server.
<li>
<strong>namespace</strong>
- The key that should be used to store the configuration and be used as
+ The key that should be used to store the configuration and be used as the
channel name for the pub/sub channel. Defaults to <code>versions</code>
</li>
</ul>
@@ -301,7 +301,7 @@ this as default configuration.
"logger",
"custom-nodejs-module",
{
- "name": "custom-nodejs-moduel",
+ "name": "custom-nodejs-module",
"config": {
"custom": "configuration options that will be feed in to the middleware"
}
@@ -312,11 +312,11 @@ 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
-second value in the actual value:
+second value is the actual value:
```js
var versions = require('versions');

0 comments on commit a04cff7

Please sign in to comment.