Skip to content
Browse files

updated readme

  • Loading branch information...
1 parent 1cf0b89 commit d99cdb4b3996e3b57e85f69cc68ca01405a61c31 @olegp committed Oct 20, 2011
Showing with 14 additions and 6 deletions.
  1. +7 −3 README.md
  2. +7 −3 pages/index.md
View
10 README.md
@@ -1,7 +1,6 @@
# MCMS
-MCMS is a fast Minimal CMS written in server side JavaScript. It uses only the
-file system and as such runs without a database. [Mustache](http://mustache.github.com/) is used for defining the templates and [GitHub flavored Markdown](https://github.com/isaacs/github-flavored-markdown) for the pages. It also includes basic support for creating a list of links to all pages, making it possible to use it as a simple blog.
+MCMS is a fast Minimal CMS written in server side JavaScript. It uses only the file system and as such runs without a database. [Mustache](http://mustache.github.com/) is used for defining the templates and [GitHub flavored Markdown](https://github.com/isaacs/github-flavored-markdown) for the pages. It also includes basic support for creating a list of links to all pages, making it possible to use it as a simple blog.
By being built on top of the [CommonJS](http://commonjs.org) [Filesystem/A](http://wiki.commonjs.org/wiki/Filesystem/A) and [JSGI 0.3](http://wiki.commonjs.org/wiki/JSGI/Level0/A/Draft2) specs, it runs on any server side JavaScript platform, such as Node.js (via [Common Node](http://olegp.github.com/common-node/)) and [RingoJS](http://ringojs.org).
@@ -11,7 +10,7 @@ If you're on Node, install MCMS with `npm install mcms` (TODO: publish to npm).
The easiest way to get started with a new site is to clone an already existing one and modify it to get the site you want (TODO: add link to repo). Alternatively, if you're starting from scratch you can also create a directory for your site. Inside it, add a single file named `index.js` with the following line:
- exports.app = require('mcms').app;
+ exports.app = require('mcms').app;
In the same directory, create the following sub-directories:
@@ -28,6 +27,11 @@ To serve the site, run `common-node .` inside the site directory. For an example
* including partial Markdown (md) files in one or more templates
* including a list of all the pages for a blog
+### Acknowledgements
+
+ * [Jan Lehnardt](http://github.com/janl/) for the CommonJS implementation of Mustache
+ * [Isaac Schlueter](http://github.com/isaacs/) for the `github-flavored-markdown` package
+
### License
(The MIT License)
View
10 pages/index.md
@@ -1,7 +1,6 @@
# MCMS
-MCMS is a fast Minimal CMS written in server side JavaScript. It uses only the
-file system and as such runs without a database. [Mustache](http://mustache.github.com/) is used for defining the templates and [GitHub flavored Markdown](https://github.com/isaacs/github-flavored-markdown) for the pages. It also includes basic support for creating a list of links to all pages, making it possible to use it as a simple blog.
+MCMS is a fast Minimal CMS written in server side JavaScript. It uses only the file system and as such runs without a database. [Mustache](http://mustache.github.com/) is used for defining the templates and [GitHub flavored Markdown](https://github.com/isaacs/github-flavored-markdown) for the pages. It also includes basic support for creating a list of links to all pages, making it possible to use it as a simple blog.
By being built on top of the [CommonJS](http://commonjs.org) [Filesystem/A](http://wiki.commonjs.org/wiki/Filesystem/A) and [JSGI 0.3](http://wiki.commonjs.org/wiki/JSGI/Level0/A/Draft2) specs, it runs on any server side JavaScript platform, such as Node.js (via [Common Node](http://olegp.github.com/common-node/)) and [RingoJS](http://ringojs.org).
@@ -11,7 +10,7 @@ If you're on Node, install MCMS with `npm install mcms` (TODO: publish to npm).
The easiest way to get started with a new site is to clone an already existing one and modify it to get the site you want (TODO: add link to repo). Alternatively, if you're starting from scratch you can also create a directory for your site. Inside it, add a single file named `index.js` with the following line:
- exports.app = require('mcms').app;
+ exports.app = require('mcms').app;
In the same directory, create the following sub-directories:
@@ -28,6 +27,11 @@ To serve the site, run `common-node .` inside the site directory. For an example
* including partial Markdown (md) files in one or more templates
* including a list of all the pages for a blog
+### Acknowledgements
+
+ * [Jan Lehnardt](http://github.com/janl/) for the CommonJS implementation of Mustache
+ * [Isaac Schlueter](http://github.com/isaacs/) for the `github-flavored-markdown` package
+
### License
(The MIT License)

0 comments on commit d99cdb4

Please sign in to comment.
Something went wrong with that request. Please try again.