Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Install docs

  • Loading branch information...
commit 63d02f1d5fd173dee01f3adf50088e1f535acb24 1 parent dfecbe5
@tj tj authored
View
14 Readme.md
@@ -12,6 +12,20 @@
app.listen(3000);
+## Installation
+
+npm:
+
+ $ npm install express
+
+curl (or similar):
+
+ $ curl -# http://github.com/extjs/Connect/raw/master/install.sh | sh
+
+git clone or tarball:
+
+ $ make install
+
## Features
* Robust routing
View
41 docs/guide.1
@@ -3,6 +3,45 @@
.
.TH "GUIDE" "" "July 2010" "" ""
.
+.SS "Installation"
+npm:
+.
+.IP "" 4
+.
+.nf
+
+$ npm install express
+.
+.fi
+.
+.IP "" 0
+.
+.P
+curl (or similar):
+.
+.IP "" 4
+.
+.nf
+
+$ curl \-# http://github\.com/extjs/Connect/raw/master/install\.sh | sh
+.
+.fi
+.
+.IP "" 0
+.
+.P
+git clone or tarball for \fBHEAD\fR:
+.
+.IP "" 4
+.
+.nf
+
+$ make install
+.
+.fi
+.
+.IP "" 0
+.
.SS "Creating An Application"
The \fIexpress\.Server\fR now inherits from \fIhttp\.Server\fR, however follows the same idiom by providing \fIexpress\.createServer()\fR as shown below\. This means that you can utilize Express server\'s transparently with other libraries\.
.
@@ -76,7 +115,7 @@ app\.configure(function(){
Express supports the following settings out of the box:
.
.IP "\(bu" 4
-\fIhome\fR Application base path used with \fBres\.redirect()\fR
+\fIhome\fR Application base path used with \fIres\.redirect()\fR
.
.IP "\(bu" 4
\fIviews\fR Root views directory defaulting to \fBCWD/views\fR
View
19 docs/guide.html
@@ -160,6 +160,23 @@
<li><a href="migrate.html">1.x Migration</a></li>
</ul>
<div class='mp'>
+<h3 id="Installation">Installation</h3>
+
+<p>npm:</p>
+
+<pre><code>$ npm install express
+</code></pre>
+
+<p>curl (or similar):</p>
+
+<pre><code>$ curl -# http://github.com/extjs/Connect/raw/master/install.sh | sh
+</code></pre>
+
+<p>git clone or tarball for <strong>HEAD</strong>:</p>
+
+<pre><code>$ make install
+</code></pre>
+
<h3 id="Creating-An-Application">Creating An Application</h3>
<p>The <em>express.Server</em> now inherits from <em>http.Server</em>, however
@@ -219,7 +236,7 @@ <h3 id="Settings">Settings</h3>
<p>Express supports the following settings out of the box:</p>
<ul>
-<li><em>home</em> Application base path used with <code>res.redirect()</code></li>
+<li><em>home</em> Application base path used with <em>res.redirect()</em></li>
<li><em>views</em> Root views directory defaulting to <strong>CWD/views</strong></li>
<li><em>view engine</em> Default view engine name for views rendered without extensions</li>
<li><em>reload views</em> Reloads altered views, by default watches for <em>mtime</em> changes with
View
16 docs/guide.md
@@ -1,4 +1,18 @@
+### Installation
+
+npm:
+
+ $ npm install express
+
+curl (or similar):
+
+ $ curl -# http://github.com/extjs/Connect/raw/master/install.sh | sh
+
+git clone or tarball for **HEAD**:
+
+ $ make install
+
### Creating An Application
The _express.Server_ now inherits from _http.Server_, however
@@ -54,7 +68,7 @@ For internal and arbitrary settings Express provides the _set(key[, val])_, _ena
Express supports the following settings out of the box:
- * _home_ Application base path used with `res.redirect()`
+ * _home_ Application base path used with _res.redirect()_
* _views_ Root views directory defaulting to **CWD/views**
* _view engine_ Default view engine name for views rendered without extensions
* _reload views_ Reloads altered views, by default watches for _mtime_ changes with
View
3  docs/index.1
@@ -67,6 +67,9 @@ Google Group \fIhttp://groups\.google\.com/group/express\-js\fR for discussion
Follow tjholowaychuk \fIhttp://twitter\.com/tjholowaychuk\fR on twitter for updates
.
.IP "\(bu" 4
+Annotated source documentation \fIapi\.html\fR
+.
+.IP "\(bu" 4
View the source \fIhttp://github\.com/visionmedia/express\fR
.
.IP "" 0
View
1  docs/index.html
@@ -198,6 +198,7 @@ <h2 id="More-Information">More Information</h2>
<ul>
<li><a href="http://groups.google.com/group/express-js">Google Group</a> for discussion</li>
<li>Follow <a href="http://twitter.com/tjholowaychuk">tjholowaychuk</a> on twitter for updates</li>
+<li>Annotated source <a href="api.html">documentation</a></li>
<li>View the <a href="http://github.com/visionmedia/express">source</a></li>
</ul>
View
1  docs/index.md
@@ -29,4 +29,5 @@ The following are the major contributors of Express (in no specific order).
* [Google Group](http://groups.google.com/group/express-js) for discussion
* Follow [tjholowaychuk](http://twitter.com/tjholowaychuk) on twitter for updates
+ * Annotated source [documentation](api.html)
* View the [source](http://github.com/visionmedia/express)
Please sign in to comment.
Something went wrong with that request. Please try again.