diff --git a/package.json b/package.json index 618edf7..f81e1e6 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { - "name": "shipyard", - "version": "0.0.0", - "description": "A super tiny static site generator.", + "name": "panini", + "version": "0.1.0", + "description": "A super tiny flat file compiler.", "main": "index.js", "scripts": { "test": "cd test && gulp" diff --git a/readme.md b/readme.md index f716aee..2d04580 100644 --- a/readme.md +++ b/readme.md @@ -1,18 +1,18 @@ -# Shipyard +# Panini A super tiny flat file generator for use with Gulp. It compiles a series of HTML *pages* using a common *layout*. These pages can also include *partials*, or external *data* as JSON or YAML. -Shipyard isn't quite a full-fledged static site generator—rather, it solves the very specific problem of assembling flat files from common elements. +Shipyard isn't meant to be full-fledged static site generator—rather, it solves the very specific problem of assembling flat files from common elements, using a templating language. ## Usage ```js var gulp = require('gulp'); -var shipyard = require('shipyard'); +var panini = require('panini'); gulp.task('default', function() { gulp.src('pages/**/*.html') - .pipe(shipyard({ + .pipe(panini({ layouts: 'layouts/', partials: 'partials/**/*.html' })) diff --git a/test/Gulpfile.js b/test/Gulpfile.js index 67545ae..bdddf0c 100644 --- a/test/Gulpfile.js +++ b/test/Gulpfile.js @@ -1,9 +1,9 @@ var gulp = require('gulp'); -var shipyard = require('../index'); +var panini = require('../index'); gulp.task('default', function() { gulp.src('pages/**/*.html') - .pipe(shipyard({ + .pipe(panini({ layouts: 'layouts/', partials: 'partials/**/*.html', data: 'data/**/*.{json,yml}',