nodepaper - npm Package Compare versions

Comparing version 0.1.2 to 0.1.3

lib/content.js

@@ -14,3 +14,3 @@ //
   , when = require('when')
-  , PREAMBLE_REGEX = /([a-z]+)\s*:(.*)/i
+  , PREAMBLE_REGEX = /^\s*([a-z]+)\s*:(.*)/i
 
@@ -17,0 +17,0 @@ marked.setOptions({

package.json

 {
   "name": "nodepaper",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "A very simple Node.js-based content management system.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,4 +0,42 @@
-nodepaper
-=========
+# Nodepaper
 
-A very simple Node.js-based content management system.
+Nodepaper is a blog engine similar in style to [Wheat](https://github.com/creationix/wheat) and [Scriptogram](http://scriptogr.am/).
+
+## Purpose
+
+The purpose of Nodepaper was strictly to get me writing more. I prefer authoring content as Markdown pages, and really appreciated the preamble-whitespace-content style of [Wheat](https://github.com/creationix/wheat) and [Scriptogram](http://scriptogr.am/). Making things even simpler, the feature supported by Nodepaper are the _intersection_ of [Wheat](https://github.com/creationix/wheat) and [Scriptogram](http://scriptogr.am/), not the union. As such, there's no multi-author support, no comments, and no "advanced" options like "Slug" in the preamble.
+
+## How to Use
+
+ 1. Start a new project as a Node.js module, complete with its own `package.json` file.
+ 2. Install nodepaper as a dependency with `npm install nodepaper --save`.
+ 3. Create up to two directories. One for the theme (optional), and one for your content (not optional).
+ 4. Add an `npm start` script to `package.json`, invoking `nodepaper` with the directories from step 3.
+ 5. Enjoy!
+
+For an example project, see [the schoonology.com source](https://github.com/Schoonology/schoonology.com).
+
+## License
+
+    Copyright (C) 2012-2013 Michael Schoonmaker ([e-mail])
+
+    This project is free software released under the MIT/X11 license:
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in
+    all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+    THE SOFTWARE.
+

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

21625

increased by12.5%

Number of lines in readme file

43

increased by975%

No dependency changes