From dd4a89ef0e7b63cebee368fd7fd8b0dc23fd227f Mon Sep 17 00:00:00 2001 From: Sondre Nilsen Date: Wed, 1 Jun 2016 03:10:02 +0200 Subject: [PATCH] Add jekyllized content to the README --- generators/app/index.js | 21 ++++++++++++++++++++- test/readme.js | 4 ++++ 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/generators/app/index.js b/generators/app/index.js index 81ee746..f27f0f4 100644 --- a/generators/app/index.js +++ b/generators/app/index.js @@ -126,7 +126,26 @@ module.exports = generators.Base.extend({ projectName: this.props.projectName, projectDescription: this.props.projectDescription, projectURL: this.props.projectURL, - authorName: this.props.authorName + authorName: this.props.authorName, + content: ` +#### Settings +In your \`_config.yml\` and \`humans.txt\` you should add your Github and Twitter +profile if you want to. + +## Install +If you have cloned this repo or want to reinstall, make sure there's no +\`node_modules\` or \`Gemfile.lock\` folder/file and then run \`npm install\` and +\`bundle install\`. + +#### Update +To update: \`npm update generator-jekyllized -g\`, then run \`yo jekyllized:gulp +[--rsync|amazon|pages]\` in this directory. Note that this will overwrite any +local changes, so back it up. + +## Github +For more information on how to use your new project, please refer to the [README +on Github](https://github.com/sondr3/generator-jekyllized). +` } }, { local: require.resolve('generator-statisk/generators/readme') diff --git a/test/readme.js b/test/readme.js index 0b6019c..06a6c70 100644 --- a/test/readme.js +++ b/test/readme.js @@ -28,6 +28,10 @@ test('README is correct', () => { [ '# README', '> This is a great README', + '#### Settings', + '## Install', + '#### Update', + 'https://github.com/sondr3/generator-jekyllized', '[Ola Nordmann](http://hello-world.com)' ].forEach(field => { assert.fileContent('README.md', field);